Hexagon Geospatial
MENU

API

M.App Portfolio provides a modern, cloud-based platform for creating and delivering diverse geospatial web applications.
Through the M.App Studio, our partners can design, build, and deploy their own Hexagon Smart M.Apps.
Showing results for 
Search instead for 
Do you mean 

Foundation - Dataset Operations API

by Technical Evangelist on ‎11-09-2016 12:12 PM (385 Views)

Foundation - Dataset Operations API

Provides various operations that can be performed on Smart M.App catalog datasets. 

 

Request all running dataset operations

Returns a JSON array of objects, each object will contain information about a specific dataset operation.

 

Request Endpoint:
GET https://mapp.hexagongeospatial.com/api/v1/datasetops

 

Successful Response: 
 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"
  }
]
 
Error Response:
HTTP Status Code Description Payload 
 401 Error, not authorized.  There is no payload for this response.  
 500 Unexpected error. 

 


Request information about a given dataset operation

Returns information about a specific dataset operation.

 

Request Endpoint:
GET https://mapp.hexagongeospatial.com/api/v1/datasetops/{datasetopId}

 

Request Parameters:
Title Required Type Values Description 
 datasetopId true String Any valid datasetopId.   Id for a running dataset operation.

 

Successful Response:
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"
}

 

Error 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.
404 Error, item not found.
500  Unexpected error while processing the request 

 

 

 

Create a new folder

Creates a new folder in a user's catalog.

 

Request Endpoint:
PUT https://mapp.hexagongeospatial.com/api/v1/datasetops/folder

 

Request Parameters:
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.

 

Successful Response:
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.

 

Error 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.

 

 

Cancel a running dataset operation

Provides the ability to stop all progress of a dataset operation.

 

Request Endpoint:
PUT https://mapp.hexagongeospatial.com/api/v1/datasetops/{datasetopId}/cancel

 

Request Parameters:
Title Required Type  Values  Description 
datasetopId true  QueryString Parameter  Any valid running datasetopId.  Id of the dataset operation to be canceled. 

 

Successful Response:
HTTP Stauts Code Description  Payload 
202 Successfully canceled a running dataset operation.  There is no payload for this response.

 

Error 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.

 

 

 

Delete a collection of datasets or folders

Provides the ability to permanently delete a set of catalog datasets or folders.

 

Request Endpoint:
POST https://mapp.hexagongeospatial.com/api/v1/datasetops/delete

 

Request Parameters:
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.

 

Successful Response:
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"
}

 

Error 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. 
404 Error, item not found.
500 Unexpected error while processing the request.

 

 

Delete an existing dataset operation

Deletes all information about a specific dataset operation.

 

Request Endpoint:
DELETE https://mapp.hexagongeospatial.com/api/v1/datasetops/{datasetopId}

 

Request Parameters:
Title Required Type Values  Description 
 datasetopId true String Any valid datasetopId.  Id of the dataset operation to be deleted. 

 

Successful Response:
HTTP Status Code Description Payload 
204 Successfully deleted a dataset operation.   There is no payload for this response.

 

Error 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.

 

 

Contributors