mytardis facility¶
usage: mytardis facility [-h] {list,get} ...
Positional Arguments¶
- command
Possible choices: list, get
available commands
Sub-commands:¶
list¶
Display a list of facility records.
mytardis facility list
[--limit LIMIT] [--offset OFFSET] [--order_by ORDER_BY] [--json]
EXAMPLE
$ mytardis facility list
Model: Facility
Query: http://mytardisdemo.erc.monash.edu.au/api/v1/facility/?format=json
Total Count: 2
Limit: 20
Offset: 0
+----+---------------+------------------------+
| ID | Name | Manager Group |
+====+===============+========================+
| 1 | Demo Facility | demo-facility-managers |
+----+---------------+------------------------+
| 2 | Test Facility | test-facility-managers |
+----+---------------+------------------------+
Named Arguments¶
- --limit
Maximum number of results to return.
- --offset
Skip this many records from the start of the result set.
- --order_by
Order by this field.
- --json
Display results in JSON format.
Default: False
get¶
Display a single facility record.
mytardis facility get [-h] [--json] facility_id
EXAMPLE
$ mytardis facility get 1
Model: Facility
+----------------+------------------------+
| Facility field | Value |
+================+========================+
| ID | 1 |
+----------------+------------------------+
| Name | Demo Facility |
+----------------+------------------------+
| Manager Group | demo-facility-managers |
+----------------+------------------------+
Model: Instrument
Query: http://mytardisdemo.erc.monash.edu.au/api/v1/instrument/?format=json&facility__id=1
Total Count: 3
Limit: 20
Offset: 0
+----+-------------------------+---------------+
| ID | Name | Facility |
+====+=========================+===============+
| 3 | Test Instrument | Demo Facility |
+----+-------------------------+---------------+
| 4 | Beamline | Demo Facility |
+----+-------------------------+---------------+
| 8 | James Test Instrument | Demo Facility |
+----+-------------------------+---------------+
Positional Arguments¶
- facility_id
The facility ID.
Named Arguments¶
- --json
Display results in JSON format.
Default: False