Provides various operations that can be performed on Smart M.App catalog datasets.
Returns a JSON array of objects, each object will contain information about a specific dataset operation.
GET https://mapp.hexagongeospatial.com/api/v1/datasetops
HTTP Status Code | Description | Payload |
200 | Successfully retrieved all running dataset operations. |
[ { "datasetOpType": "Delete", "displayableStatus": "string", "endTime": "string", "id": "string", "progress": "string", "startTime": "string", "state": "WAITING" } ] |
HTTP Status Code | Description | Payload |
401 | Error, not authorized. | There is no payload for this response. |
500 | Unexpected error. |
Returns information about a specific dataset operation.
GET https://mapp.hexagongeospatial.com/api/v1/datasetops/{datasetopId}
Title | Required | Type | Values | Description |
datasetopId | true | String | Any valid datasetopId. | Id for a running dataset operation. |
HTTP Status Code | Description | Payload |
200 | Successfully retrieved information about a dataset operation. |
{ "datasetIds": [ "string" ], "datasetOpType": "Delete", "displayableStatus": "string", "endTime": "string", "id": "string", "progress": "string", "startTime": "string", "state": "WAITING" } |
HTTP Status Code | Description | Payload |
401 | Error, not authorized to access the catalog. | There is no payload for this response. |
403 | Error, forbidden to access the item. | |
404 | Error, item not found. | |
500 | Unexpected error while processing the request |
Creates a new folder in a user's catalog.
PUT https://mapp.hexagongeospatial.com/api/v1/datasetops/folder
Title | Required | Type | Values | Description |
name | true | String | Any valid JSON string | Name of the newly created folder. |
description | false | String | Any valid JSON string | Short description of created folder. |
parentId | true | String | Any valid catalog id for a folder | Parent folder of the newly created folder. |
HTTP Status Code | Description | Payload |
200 | Successfully created a new folder. | A successful response will contain the catalog item id of the newly created folder. |
HTTP Status Code | Description | Payload |
401 | Error, not authorized to access the catalog. | There is no payload for this response. |
403 | Error, forbidden to access the item. | |
500 | Unexpected error while processing the request. |
Provides the ability to stop all progress of a dataset operation.
PUT https://mapp.hexagongeospatial.com/api/v1/datasetops/{datasetopId}/cancel
Title | Required | Type | Values | Description |
datasetopId | true | QueryString Parameter | Any valid running datasetopId. | Id of the dataset operation to be canceled. |
HTTP Stauts Code | Description | Payload |
202 | Successfully canceled a running dataset operation. | There is no payload for this response. |
HTTP Status Code | Description | Payload |
401 | Error, not authorized to access the catalog. | There is no payload for this response. |
403 | Error, forbidden to access the item. | |
500 |
Unexpected error while processing the request. |
Provides the ability to permanently delete a set of catalog datasets or folders.
POST https://mapp.hexagongeospatial.com/api/v1/datasetops/delete
Title | Requred | Type | Values | Description |
ids | true | Array[String] | Any valid catalog item id. | A collection of catalog item id's the user wants to delete. |
HTTP Status Code | Description | Payload |
202 | Successfully deleted a set of catalog items. |
{ "datasetIds": [ "string" ], "datasetOpType": "Delete", "displayableStatus": "string", "endTime": "string", "id": "string", "progress": "string", "startTime": "string", "state": "WAITING" } |
HTTP Status Code | Description | Payload |
401 | Error, not authorized to access the catalog. | There is no payload for this response. |
403 | Error, forbidden to access the item. | |
404 | Error, item not found. | |
500 | Unexpected error while processing the request. |
Deletes all information about a specific dataset operation.
DELETE https://mapp.hexagongeospatial.com/api/v1/datasetops/{datasetopId}
Title | Required | Type | Values | Description |
datasetopId | true | String | Any valid datasetopId. | Id of the dataset operation to be deleted. |
HTTP Status Code | Description | Payload |
204 | Successfully deleted a dataset operation. | There is no payload for this response. |
HTTP Status Code | Description | Payload |
400 | Error with details in the response body. | There is no payload for this response. |
401 | Error, not authorized to access the catalog. | |
403 | Error, forbidden to access the item. | |
404 | Error, item not found. | |
500 | Unexpected error while processing the request. |