MapColonies Export Service (1.4.2)

Download OpenAPI specification:Download

License: MIT

Export Service for DEM, Raster, 3D

Tasks

Create an export task

Request Body schema: application/json

task details

catalogRecordID required	string <uuid>
domain required	string Enum: "DEM" "3D" "RASTER"
	object (FeatureCollection) GeoJson Feature Collection
artifactCRS required	string Value: "4326"
description	string
keywords	object task metadata in key-value pair
parameters	object task parameters in key-value pair
required	Array of objects describe one or more relevant events to receive the data once event has been occurred

Responses

Request samples

Payload

Content type

application/json

{"catalogRecordID": "6770b7de-063c-4b27-9653-aa1545a34afa",
"domain": "DEM",
"ROI": {"type": "FeatureCollection",
"features": [{"type": "Feature",
"properties": {"property1": null,
"property2": null
},
"geometry": {"type": "Polygon",
"coordinates": [[[0,
0
]
]
]
}
}
]
},
"artifactCRS": "4326",
"description": "string",
"keywords": {"foo": "kuku"
},
"parameters": {"foo": "kuku"
},
"webhook": [{"events": ["TASK_COMPLETED"
],
"url": "https://webhook.com"
}
]
}

Response samples

Content type

application/json

{"catalogRecordID": "6770b7de-063c-4b27-9653-aa1545a34afa",
"domain": "DEM",
"ROI": {"type": "FeatureCollection",
"features": [{"type": "Feature",
"properties": {"property1": null,
"property2": null
},
"geometry": {"type": "Polygon",
"coordinates": [[[0,
0
]
]
]
}
}
]
},
"artifactCRS": "4326",
"description": "string",
"keywords": {"foo": "kuku"
},
"parameters": {"foo": "kuku"
},
"webhook": [{"events": ["TASK_COMPLETED"
],
"url": "https://webhook.com"
}
],
"id": 0,
"estimatedSize": 0,
"estimatedTime": 0,
"status": "IN_PROGRESS",
"errorReason": "string",
"progress": 100,
"artifacts": [{"type": "GPKG",
"name": "string",
"size": 124215121,
"url": "https://download.com/file"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"expiredAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z"
}

get task by id

path Parameters

id

required

number

Responses

Response samples

Content type

application/json

{"catalogRecordID": "6770b7de-063c-4b27-9653-aa1545a34afa",
"domain": "DEM",
"ROI": {"type": "FeatureCollection",
"features": [{"type": "Feature",
"properties": {"property1": null,
"property2": null
},
"geometry": {"type": "Polygon",
"coordinates": [[[0,
0
]
]
]
}
}
]
},
"artifactCRS": "4326",
"description": "string",
"keywords": {"foo": "kuku"
},
"parameters": {"foo": "kuku"
},
"webhook": [{"events": ["TASK_COMPLETED"
],
"url": "https://webhook.com"
}
],
"id": 0,
"estimatedSize": 0,
"estimatedTime": 0,
"status": "IN_PROGRESS",
"errorReason": "string",
"progress": 100,
"artifacts": [{"type": "GPKG",
"name": "string",
"size": 124215121,
"url": "https://download.com/file"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"expiredAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z"
}