The Get Order endpoint allows the return of a detailed order object, including a list of contained tasking campaigns and datasets.
get /api/campaign/{campaign}
Path Parameters:
* Required
| Field | Description |
|---|
Responses:
- 200
- 400
- 401
The List endpoint returns all pending and completed datasets. It will not populate the list of child resources.
get /api/campaign/{campaign}/datasets
Path Parameters:
* Required
| Field | Description |
|---|---|
| campaign | The UUID of the campaign to list datasets belonging to. |
URL Parameters:
* Required
| Field | Description |
|---|---|
| page | The page of results to retrieve |
| size | The size of the page of results to retrieve |
?page=3
&size=Responses:
- 200
- 400
- 401
| Field | Type | Description |
|---|---|---|
| content | array | List of overviews of each dataset. |
| count | integer | Number of items returned in the current page |
| length | integer | Length of the current result page |
| page | integer | Current result page index (0 indexed) |
The List endpoint returns all pending and completed orders. It will not populate the list of child datasets and campaigns
get /api/campaigns
URL Parameters:
* Required
| Field | Description |
|---|---|
| page | The page of results to retrieve |
| size | The size of the page of results to retrieve |
?page=3
&size=Responses:
- 200
- 400
- 401
| Field | Type | Description |
|---|---|---|
| content | array | List of overviews of each order. |
| count | integer | Number of items returned in the current page |
| length | integer | Length of the current result page |
| page | integer | Current result page index (0 indexed) |
The Get Dataset endpoint allows the return of a detailed dataset object, including the list of associated resources available for download.
get /api/dataset/{dataset}
Path Parameters:
* Required
| Field | Description |
|---|---|
| dataset* | The UUID of the target dataset. |
Responses:
- 200
- 400
- 401
The Get Resource endpoint allows the return of a resource object.
get /api/dataset/{dataset}/resource/{resource}
Path Parameters:
* Required
| Field | Description |
|---|---|
| resource* | The UUID of the target resource. |
| dataset | The UUID of the dataset this resources should belong to (validation check). |
Responses:
- 200
- 400
- 401
The Download Resource endpoint allows the download of a resource contents.
get /api/dataset/{dataset}/resource/{resource}/data
Path Parameters:
* Required
| Field | Description |
|---|---|
| resource* | The UUID of the target resource. |
| dataset | The UUID of the dataset this resources should belong to (validation check). |
Responses:
- 200
- 400
- 401
- 410
The List endpoint returns all pending and completed datasets. It will not populate the list of child resources.
get /api/datasets
URL Parameters:
* Required
| Field | Description |
|---|---|
| page | The page of results to retrieve |
| size | The size of the page of results to retrieve |
?page=3
&size=Responses:
- 200
- 400
- 401
| Field | Type | Description |
|---|---|---|
| content | array | List of overviews of each dataset. |
| count | integer | Number of items returned in the current page |
| length | integer | Length of the current result page |
| page | integer | Current result page index (0 indexed) |
The Get Order endpoint allows the return of a detailed order object, including a list of contained tasking campaigns and datasets.
get /api/order/{order}
Path Parameters:
* Required
| Field | Description |
|---|---|
| order* | The UUID of the target order. |
Responses:
- 200
- 400
- 401
The List endpoint returns all pending and completed orders. It will not populate the list of child datasets and campaigns
get /api/order/{order}/campaigns
Path Parameters:
* Required
| Field | Description |
|---|
URL Parameters:
* Required
| Field | Description |
|---|---|
| page | The page of results to retrieve |
| size | The size of the page of results to retrieve |
?page=3
&size=Responses:
- 200
- 400
- 401
| Field | Type | Description |
|---|---|---|
| content | array | List of overviews of each order. |
| count | integer | Number of items returned in the current page |
| length | integer | Length of the current result page |
| page | integer | Current result page index (0 indexed) |
The List endpoint returns all pending and completed datasets. It will not populate the list of child resources.
get /api/order/{order}/datasets
Path Parameters:
* Required
| Field | Description |
|---|---|
| order | The UUID of the order to list datasets belonging to. |
URL Parameters:
* Required
| Field | Description |
|---|---|
| page | The page of results to retrieve |
| size | The size of the page of results to retrieve |
?page=3
&size=Responses:
- 200
- 400
- 401
| Field | Type | Description |
|---|---|---|
| content | array | List of overviews of each dataset. |
| count | integer | Number of items returned in the current page |
| length | integer | Length of the current result page |
| page | integer | Current result page index (0 indexed) |
The List endpoint returns all pending and completed orders. It will not populate the list of child datasets and campaigns
get /api/orders
URL Parameters:
* Required
| Field | Description |
|---|---|
| page | The page of results to retrieve |
| size | The size of the page of results to retrieve |
?page=3
&size=Responses:
- 200
- 400
- 401
| Field | Type | Description |
|---|---|---|
| content | array | List of overviews of each order. |
| count | integer | Number of items returned in the current page |
| length | integer | Length of the current result page |
| page | integer | Current result page index (0 indexed) |
The Get Resource endpoint allows the return of a resource object.
get /api/resource/{resource}
Path Parameters:
* Required
| Field | Description |
|---|---|
| resource* | The UUID of the target resource. |
Responses:
- 200
- 400
- 401
The Download Resource endpoint allows the download of a resource contents.
get /api/resource/{resource}/data
Path Parameters:
* Required
| Field | Description |
|---|---|
| resource* | The UUID of the target resource. |
Responses:
- 200
- 400
- 401
- 410