{ "x-generator": "NSwag v14.2.0.0 (NJsonSchema v11.1.0.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "SatelliteHub API", "description": "Check our github repo with examples at ClearSky API Tools
Check our wiki docs at ClearSky Wiki documentation", "version": "1.0.0", "x-logo": { "url": "https://clearsky.vision/wp-content/uploads/2020/09/clearsky_vision408.5x.png", "backgroundColor": "#323232" } }, "paths": { "/api/account/info": { "get": { "tags": [ "Account" ], "summary": "Get Account Info", "description": "Retrieves information related to the API key used for the request, such as request limits.", "operationId": "Account_GetApiKeyInfo", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfApiKeyLimitedDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/account/settings": { "get": { "tags": [ "Account" ], "summary": "Get Account Settings", "description": "Retrieves Settings specified for account based on ApiKey, such as those related to the service.", "operationId": "Account_GetApiKeySettings", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfApiKeySettingsDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/billing/summary": { "get": { "tags": [ "Billing" ], "summary": "Get billing summary", "description": "Retrieves an overview of billing information for the current month for the API key used in the request.", "operationId": "Billing_GetSummary", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfBillingSummaryDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/billing/orders/{year}-{month}": { "get": { "tags": [ "Billing" ], "summary": "Get itemized billing orders for month", "description": "Retrieves a list of orders and their costs for the specified month and year for the API key used in the request.", "operationId": "Billing_GetOrdersForMonth", "parameters": [ { "name": "year", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "month", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfBillingOrdersListDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/billing/transactions/{year}-{month}": { "get": { "tags": [ "Billing" ], "summary": "Get itemized list of Euro balance transactions for month", "description": "Retrieves an itemized list of Euro balance transactions for the specified month and year for the API key used in the request.", "operationId": "Billing_GetTransactionsForMonth", "parameters": [ { "name": "year", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "month", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfBillingTransactionsListDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/billing/vouchers/redeem": { "post": { "tags": [ "Billing" ], "summary": "Redeem a voucher", "description": "Redeems a voucher and adds the corresponding credit to the API key used in the request.", "operationId": "Billing_RedeemVoucher", "requestBody": { "x-name": "command", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedeemVoucherCommand" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfVoucherRedeemResultDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/satelliteimages/geography/composite": { "post": { "tags": [ "SatelliteImages" ], "summary": "Retrieve available imagery in composite area for period.", "description": "Retrieves a new composite area containing dates of available cloud-less satellite imagery.\n\nGeog - Geography in EPSG 4326 for which the Geogwkt intersection with internal tiles will be returned.", "operationId": "SatelliteImages_RetrieveCompositeInGeog", "requestBody": { "x-name": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCompositeSatelliteImagesByGeogWktQuery" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfSatelliteMergedAreaDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } }, "deprecated": true } }, "/api/satelliteimages/search/available": { "post": { "tags": [ "SatelliteImages" ], "summary": "Search for available imagery in area and period.", "description": "Retrieves the intersection of the search geography with the ordered geographies or tiles, if they contain any available satellite imagery on dates within the period.", "operationId": "SatelliteImages_SearchAvailableImagery", "requestBody": { "x-name": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchTaskedAvailableSatelliteImageryQuery" }, "example": { "Wkt": "POLYGON ((9.877893206725581 56.47856668238974, 10.196496722350581 56.47856668238974, 10.196496722350581 56.27782087776097, 9.877893206725581 56.27782087776097, 9.877893206725581 56.47856668238974))", "GeoJson": { "type": "Polygon", "coordinates": [ [ [ 9.877893206725581, 56.47856668238974 ], [ 10.196496722350581, 56.47856668238974 ], [ 10.196496722350581, 56.27782087776097 ], [ 9.877893206725581, 56.27782087776097 ], [ 9.877893206725581, 56.47856668238974 ] ] ] }, "From": "2024-05-03T00:00:01Z", "Until": null } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfSatelliteImagerySearchResultsDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/satelliteimages/process/composite": { "post": { "tags": [ "SatelliteImages" ], "summary": "Retrieve composite of the requested satellite imagery", "description": "Wkt or GeoJson is accepted. Either can be provided, but not both.\n\nExample GeoJson:\n\n {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [9.877893206725581, 56.47856668238974],\n [10.196496722350581, 56.47856668238974],\n [10.196496722350581, 56.27782087776097],\n [9.877893206725581, 56.27782087776097],\n [9.877893206725581, 56.47856668238974]\n ]\n ]\n }\n\n\nDate - e.g. '2022-05-26T00:00:00.000Z' or '2022-05-26'\n\nResolution - 10, 20, 40, 80, 160, 320, 640, 1280\n\nBandnames - Band options include exclusive and composable options. Exclusive options must be the only value in bandnames, and the options are ('rgb', 'all')\nThe composable options are a combination of the following bands: ('B2', 'B3', 'B4', 'B5', 'B6', 'B7', 'B8', 'B8A', 'B11', 'B12').\nIt is also possible to pre-compute remote sensing indices in the form (Band1 - Band2) / (Band1 + Band2)\nfor instance NDVI would be written as [B8_B4] and will be calculated as (B8 - B4) / (B8 + B4).\n\"B2, B7, B8, B5, [B8_B4]\" is an example containing 4 bands followed by a calculated index in the resulting file. Using 'ndvi' is another option to get '[B8_B4]'.\n\nEpsgprojection - any epsg number, e.g. 4326, 3857\n\nPixelSelectionMode - intersect (include all pixels that intersect geography), contained (include all pixels fully covered by geography)\n\nDataType - INT16 or UINT8\n - NODATA values are (INT16: -32768), (UINT8: 0)\n\nUtmDataSelectionMode - relevant only for EPSGs 32601-32660 and 32701-32760 - single_utm_fully_covered, combined_utm, single_utm\n\n single_utm_fully_covered - will strictly enforce that request polygon is overlapped by data solely in requested epsg, e.g. not half in UTM32N and other half in UTM33N\n \n combined_utm - request polygon pixels are chosen from the data in desired EPSG, and it fills out the missing pixels with data from other EPSGs that get reprojected to desired EPSG\n \n single_utm - the pixels are chosen from the data in desired EPSG, and the returned pixel array fits the dimensions of the data area that is combined_utm result without data reprojected from other EPSG e.g. the pixel array is modified to fit the actual data available.\n \nUtmGridForcePixelResolutionSize - relevant only for EPSGs 32601-32660 and 32701-32760 and affects the result when reprojection is involved - true or false\n \n true - Forces pixels to always be Resolution size in meters, even when reprojecting some pixels. The reprojection errors manifest as e.g. a twisted image instead of pixel size differences.\n \n false - Pixel size in meters may be slightly different from Resolution, even when reprojecting some pixels. The reprojection errors manifest as slightly modified pixel sizes (e.g. 9.99m instead of 10m).\n \nSatelliteConstellations - Sentinel1, Sentinel2, Landsat89, Sentinel3OLCI, Sentinel3SLSTR, WFIAmazonia, MUXCBERS4, AWFICBERS4, MUXCBERS4A, WFICBERS4A\n\nModel - For documentation on available models, visit https://api.clearsky.vision/docs/index.html?url=/api/specification.json#tag/Tasking/operation/Tasking_GetTaskingModels \n\nUploadUrl - URL to make PUT request with resulting file. File will be uploaded to URL and api will respond with 201 created.", "operationId": "SatelliteImages_ProcessCompositeSatelliteImagery", "requestBody": { "x-name": "command", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSatelliteImageCompositeCommand" }, "example": { "Wkt": "POLYGON ((9.877893206725581 56.47856668238974, 10.196496722350581 56.47856668238974, 10.196496722350581 56.27782087776097, 9.877893206725581 56.27782087776097, 9.877893206725581 56.47856668238974))", "GeoJson": { "type": "Polygon", "coordinates": [ [ [ 9.877893206725581, 56.47856668238974 ], [ 10.196496722350581, 56.47856668238974 ], [ 10.196496722350581, 56.27782087776097 ], [ 9.877893206725581, 56.27782087776097 ], [ 9.877893206725581, 56.47856668238974 ] ] ] }, "Date": "2024-05-03T00:00:00Z", "Resolution": 10, "EpsgProjection": 32632, "FileType": "tif", "PixelSelectionMode": "contained", "DataType": "INT16", "UtmDataSelectionMode": "combined_utm", "SatelliteConstellations": [ "Sentinel1", "Sentinel2", "Landsat89" ], "Model": "Stratus2", "UtmGridForcePixelResolutionSize": true, "Bandnames": "all", "OldPixelSelectionMode": false, "AllowPartialImage": false, "AutomaticOrderCreation": false, "UploadUrl": null } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "" }, "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/satelliteimages/process/minitile": { "post": { "tags": [ "SatelliteImages" ], "summary": "Retrieve MiniTile satellite imagery", "description": "MiniTileGuid is required to identify the tile to download\n\nDate - e.g. '2022-05-26T00:00:00.000Z' or '2022-05-26'\n\nSatelliteConstellations - Sentinel1, Sentinel2, Landsat89, Sentinel3OLCI, Sentinel3SLSTR, WFIAmazonia, MUXCBERS4, AWFICBERS4, MUXCBERS4A, WFICBERS4A\n\nModel - For documentation on available models, visit https://api.clearsky.vision/docs/index.html?url=/api/specification.json#tag/Tasking/operation/Tasking_GetTaskingModels \n\nUploadUrl - URL to make PUT request with resulting file. File will be uploaded to URL and api will respond with 201 created.", "operationId": "SatelliteImages_ProcessMiniTileSatelliteImagery", "requestBody": { "x-name": "command", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSatelliteImageMiniTileCommand" }, "example": { "MiniTileGuid": "c3528462-02fc-4301-bb37-8d226b45f149", "Date": "2024-05-03T00:00:00Z", "SatelliteConstellations": [ "Sentinel1", "Sentinel2", "Landsat89" ], "Model": "Stratus2", "Level": null, "Harmonize": null, "ClipReflectance": null, "UploadUrl": "https://service-allowing-put-requests-to-upload.xyz" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "" }, "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/satelliteimages/process/tile": { "post": { "tags": [ "SatelliteImages" ], "summary": "Retrieve Tile satellite imagery", "description": "TileGuid is required to identify the tile to download\n\nDate - e.g. '2022-05-26T00:00:00.000Z' or '2022-05-26'\n\nSatelliteConstellations - Sentinel1, Sentinel2, Landsat89, Sentinel3OLCI, Sentinel3SLSTR, WFIAmazonia, MUXCBERS4, AWFICBERS4, MUXCBERS4A, WFICBERS4A\n\nModel - For documentation on available models, visit https://api.clearsky.vision/docs/index.html?url=/api/specification.json#tag/Tasking/operation/Tasking_GetTaskingModels \n\nUploadUrl - URL to make PUT request with resulting file. File will be uploaded to URL and api will respond with 201 created.", "operationId": "SatelliteImages_ProcessTileSatelliteImagery", "requestBody": { "x-name": "command", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSatelliteImageTileCommand" }, "example": { "TileGuid": "c3528462-02fc-4301-bb37-8d226b45f149", "Date": "2024-05-03T00:00:00Z", "SatelliteConstellations": [ "Sentinel1", "Sentinel2", "Landsat89" ], "Model": "Stratus2", "Level": null, "Harmonize": null, "ClipReflectance": null, "UploadUrl": "https://service-allowing-put-requests-to-upload.xyz" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "" }, "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/satelliteimages/process/composite/available": { "post": { "tags": [ "SatelliteImages" ], "summary": "Query composite request is available", "description": "Wkt or GeoJson is accepted. Either can be provided, but not both.\n\nExample GeoJson:\n\n {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [9.877893206725581, 56.47856668238974],\n [10.196496722350581, 56.47856668238974],\n [10.196496722350581, 56.27782087776097],\n [9.877893206725581, 56.27782087776097],\n [9.877893206725581, 56.47856668238974]\n ]\n ]\n }\n\n\nEpsgprojection - any epsg number, e.g. 4326, 3857\n\nUtmDataSelectionMode - relevant only for EPSGs 32601-32660 and 32701-32760 - single_utm_fully_covered, combined_utm, single_utm\n\n single_utm_fully_covered - will strictly enforce that request polygon is overlapped by data solely in requested epsg, e.g. not half in UTM32N and other half in UTM33N\n \n combined_utm - request polygon pixels are chosen from the data in desired EPSG, and it fills out the missing pixels with data from other EPSGs that get reprojected to desired EPSG\n \n single_utm - the pixels are chosen from the data in desired EPSG, and the returned pixel array fits the dimensions of the data area that is combined_utm result without data reprojected from other EPSG e.g. the pixel array is modified to fit the actual data available.", "operationId": "SatelliteImages_GetAvailabilityCheckProcessCompositeSatelliteImagery", "requestBody": { "x-name": "command", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SatelliteImageCompositeAvailableQuery" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfSatelliteMergedAreaAvailableDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/satelliteimages/process/composite/estimate": { "post": { "tags": [ "SatelliteImages" ], "summary": "Retrieve download credit estimate for composite satellite imagery", "description": "Wkt or GeoJson is accepted. Either can be provided, but not both.\n\nExample GeoJson:\n\n {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [9.877893206725581, 56.47856668238974],\n [10.196496722350581, 56.47856668238974],\n [10.196496722350581, 56.27782087776097],\n [9.877893206725581, 56.27782087776097],\n [9.877893206725581, 56.47856668238974]\n ]\n ]\n }", "operationId": "SatelliteImages_GetEstimateProcessCompositeSatelliteImagery", "requestBody": { "x-name": "command", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SatelliteImageCompositeEstimateQuery" }, "example": { "Wkt": "POLYGON ((9.877893206725581 56.47856668238974, 10.196496722350581 56.47856668238974, 10.196496722350581 56.27782087776097, 9.877893206725581 56.27782087776097, 9.877893206725581 56.47856668238974))", "GeoJson": { "type": "Polygon", "coordinates": [ [ [ 9.877893206725581, 56.47856668238974 ], [ 10.196496722350581, 56.47856668238974 ], [ 10.196496722350581, 56.27782087776097 ], [ 9.877893206725581, 56.27782087776097 ], [ 9.877893206725581, 56.47856668238974 ] ] ] }, "MiniTileGuid": null, "TileGuid": null } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfSatellitePreviewEstimateDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/satelliteproducts/satellitezones/composite": { "post": { "tags": [ "SatelliteProducts" ], "summary": "Retrieve satelliteproducts for composite", "description": "Retrieves satelliteproducts intersecting with the intersection of GeogWkt and our internal tiles, each containing information about the original satellite images' satellite constellation, geography, and date.\n\nintersection with our internal tiles is required to enforce that the returned products are within areas we have active tiles", "operationId": "SatelliteProducts_RetrieveZonesInBoundingBox", "requestBody": { "x-name": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSatelliteProductsByCompositeQuery" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfSatelliteProductSatelliteCompositeDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/satelliteproducts/acquisitionplans": { "post": { "tags": [ "SatelliteProducts" ], "summary": "Retrieve satelliteproduct acquisitionplans", "description": "Retrieves planned acquisitions for satelliteproducts intersecting with the intersection of GeogWkt, each containing information about the original satellite images' satellite constellation, geography, and date.\n\nintersection with our internal tiles is required to enforce that the returned products are within areas we have active tiles", "operationId": "SatelliteProducts_GetSatelliteProductsAcquisitionPlans", "requestBody": { "x-name": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSatelliteProductsAcquisitionPlansByGeographyQuery" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfSatelliteAcquisitionPlansDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/tasking/models": { "get": { "tags": [ "Tasking" ], "summary": "Get Tasking Models", "description": "Retrieves list of Tasking Models, including their supported SatelliteConstellations. Each model can have SatelliteConstellations that are optional, and SatelliteConstellations that are required.", "operationId": "Tasking_GetTaskingModels", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfTaskingModelListDto" }, "example": { "Data": { "TaskingModels": [ { "Model": "Stratus2", "SupportedSatelliteConstellations": [ { "SatelliteConstellation": "Sentinel1", "Optional": false }, { "SatelliteConstellation": "Sentinel2", "Optional": false }, { "SatelliteConstellation": "Landsat89", "Optional": false } ] }, { "Model": "Nimbus", "SupportedSatelliteConstellations": [ { "SatelliteConstellation": "Sentinel1", "Optional": false }, { "SatelliteConstellation": "Sentinel2L1", "Optional": false }, { "SatelliteConstellation": "Landsat89", "Optional": true } ] }, { "Model": "StratusOptimized", "SupportedSatelliteConstellations": [ { "SatelliteConstellation": "Sentinel1", "Optional": false }, { "SatelliteConstellation": "Sentinel2", "Optional": false }, { "SatelliteConstellation": "Landsat89", "Optional": false } ] }, { "Model": "NimbusNDVI", "SupportedSatelliteConstellations": [ { "SatelliteConstellation": "Sentinel1", "Optional": false }, { "SatelliteConstellation": "Sentinel2L1", "Optional": false }, { "SatelliteConstellation": "Landsat89", "Optional": true } ] }, { "Model": "Stratus2Fast", "SupportedSatelliteConstellations": [ { "SatelliteConstellation": "Sentinel1", "Optional": false }, { "SatelliteConstellation": "Sentinel2", "Optional": false }, { "SatelliteConstellation": "Landsat89", "Optional": true } ] } ] }, "Succeeded": true, "Error": null } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/tasking/orders": { "get": { "tags": [ "Tasking" ], "summary": "Get Tasking Orders", "description": "Retrieves list of Tasking Orders\n\nOrderingProcessStatus - status for order\n\n Initialize - Scheduling prediction of images for area and period for order\n \n Failure - Unable to handle order, contact for more information\n \n Ongoing - Non recurring order is being processed or order is being scheduled for live data.\n \n Done - Order is complete.\n \n Review - Order is being reviewed before initialization.", "operationId": "Tasking_GetTaskOrders", "parameters": [ { "name": "recurringOnly", "in": "query", "schema": { "type": "boolean", "default": false }, "x-position": 1 }, { "name": "getExpired", "in": "query", "schema": { "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfTaskOrderListDto" }, "example": { "Data": { "TaskOrders": [ { "TaskOrderGuid": "c3528462-02fc-4301-bb37-8d226b45f149", "BillingCycle": "Monthly", "OrderingProcessStatus": "Initialize", "StorageMonths": 3, "ApiRequests": 5, "TaskOrderAreaKm2": 525.3, "SatelliteConstellations": [ "Sentinel1", "Sentinel2", "Landsat89" ], "Model": "Stratus3", "ImageFrequency": 2, "ReferenceDate": "2023-06-01", "From": "2023-06-01", "To": null, "Tiles": [], "MiniTiles": [], "Wkt": "GEOMETRYCOLLECTION (POLYGON ((8.675127 55.962046, 8.675127 55.963407, 8.679411 55.963407, 8.679411 55.962046, 8.675127 55.962046)), POLYGON ((8.472053 56.105382, 8.472053 56.337398, 8.948552 56.337398, 8.948552 56.105382, 8.472053 56.105382)), POLYGON ((8.678 55.948533, 8.678 56.068376, 8.878589 56.068376, 8.878589 55.948533, 8.678 55.948533)))", "CreatedDate": "0001-01-01T00:00:00Z", "IsAutomaticOrder": false } ] }, "Succeeded": true, "Error": null } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } }, "post": { "tags": [ "Tasking" ], "summary": "Create Tasking Order", "description": "Images are tasked for dates in each relevant month according to the formula ((number of days between date-in-month and ReferenceDate) modulus ImageFrequency). \nUnderstand order pricing at https://clearsky.vision/docs/understand-order-pricing/", "operationId": "Tasking_CreateTaskOrder", "parameters": [ { "name": "automaticOrderGuid", "in": "query", "description": "Optional query parameter. Only required for automatic order flow", "schema": { "type": "string", "format": "guid", "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "command", "description": "JSON body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTaskOrderCommand" }, "example": { "Wkt": "GEOMETRYCOLLECTION (POLYGON ((6.157837 51.388923, 6.157837 51.44716, 6.273193 51.44716, 6.273193 51.388923, 6.157837 51.388923)), POLYGON ((4.784546 50.57626, 4.784546 50.708634, 4.993286 50.708634, 4.993286 50.57626, 4.784546 50.57626)), MULTIPOLYGON (((4.855957 51.225808, 4.887543 51.232688, 4.921875 51.20086, 4.888916 51.179343, 4.864197 51.191394, 4.855957 51.225808)), ((4.625244 51.224088, 4.680176 51.268789, 4.762573 51.175899, 4.614258 51.086273, 4.625244 51.224088))))", "GeoJson": { "type": "GeometryCollection", "geometries": [ { "type": "Polygon", "coordinates": [ [ [ 6.157837, 51.388923 ], [ 6.157837, 51.44716 ], [ 6.273193, 51.44716 ], [ 6.273193, 51.388923 ], [ 6.157837, 51.388923 ] ] ] }, { "type": "Polygon", "coordinates": [ [ [ 4.784546, 50.57626 ], [ 4.784546, 50.708634 ], [ 4.993286, 50.708634 ], [ 4.993286, 50.57626 ], [ 4.784546, 50.57626 ] ] ] }, { "type": "MultiPolygon", "coordinates": [ [ [ [ 4.855957, 51.225808 ], [ 4.887543, 51.232688 ], [ 4.921875, 51.20086 ], [ 4.888916, 51.179343 ], [ 4.864197, 51.191394 ], [ 4.855957, 51.225808 ] ] ], [ [ [ 4.625244, 51.224088 ], [ 4.680176, 51.268789 ], [ 4.762573, 51.175899 ], [ 4.614258, 51.086273 ], [ 4.625244, 51.224088 ] ] ] ] } ] }, "TileGuids": [], "MiniTileGuids": [], "SatelliteConstellations": [ "Sentinel1", "Sentinel2", "Landsat89" ], "Model": "Stratus2", "StorageMonths": 3, "ApiRequests": 5, "ImageFrequency": 2, "ReferenceDate": "2023-06-01", "From": "2023-06-01", "To": null, "TileDeduplication": false, "GeometryTileOrdering": false } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfTaskOrderPublicDto" }, "example": { "Data": { "TaskOrderGuid": "c3528462-02fc-4301-bb37-8d226b45f149", "BillingCycle": "Monthly", "OrderingProcessStatus": "Initialize", "StorageMonths": 3, "ApiRequests": 5, "TaskOrderAreaKm2": 525.3, "SatelliteConstellations": [ "Sentinel1", "Sentinel2", "Landsat89" ], "Model": "Stratus3", "ImageFrequency": 2, "ReferenceDate": "2023-06-01", "From": "2023-06-01", "To": null, "Tiles": [], "MiniTiles": [], "Wkt": "GEOMETRYCOLLECTION (POLYGON ((8.675127 55.962046, 8.675127 55.963407, 8.679411 55.963407, 8.679411 55.962046, 8.675127 55.962046)), POLYGON ((8.472053 56.105382, 8.472053 56.337398, 8.948552 56.337398, 8.948552 56.105382, 8.472053 56.105382)), POLYGON ((8.678 55.948533, 8.678 56.068376, 8.878589 56.068376, 8.878589 55.948533, 8.678 55.948533)))", "CreatedDate": "0001-01-01T00:00:00Z", "IsAutomaticOrder": false }, "Succeeded": true, "Error": null } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/tasking/orders/guids/changed-since": { "get": { "tags": [ "Tasking" ], "summary": "Get order guids", "description": "Retrieves list of orders where that has changed since the specified date", "operationId": "Tasking_GetTaskOrderGuidsChangedSince", "parameters": [ { "name": "sinceUtc", "in": "query", "schema": { "type": "string", "format": "date-time" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfListOfGuid" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/tasking/orders/estimate": { "post": { "tags": [ "Tasking" ], "summary": "Create Tasking Order Estimate", "description": "Returns an estimate for a tasking order. \n\nThe estimate is calculated with the assumption that there are no changes to taskorders within the current month, and that the new taskorder does not overlap any existing taskorders.\n\nCancelling recurring taskorders may influence the actual price of other recurring taskorders.\nUnderstand order pricing at https://clearsky.vision/docs/understand-order-pricing/", "operationId": "Tasking_CreateTaskOrderEstimate", "requestBody": { "x-name": "command", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTaskOrderEstimateCommand" }, "example": { "Wkt": "GEOMETRYCOLLECTION (POLYGON ((6.157837 51.388923, 6.157837 51.44716, 6.273193 51.44716, 6.273193 51.388923, 6.157837 51.388923)), POLYGON ((4.784546 50.57626, 4.784546 50.708634, 4.993286 50.708634, 4.993286 50.57626, 4.784546 50.57626)), MULTIPOLYGON (((4.855957 51.225808, 4.887543 51.232688, 4.921875 51.20086, 4.888916 51.179343, 4.864197 51.191394, 4.855957 51.225808)), ((4.625244 51.224088, 4.680176 51.268789, 4.762573 51.175899, 4.614258 51.086273, 4.625244 51.224088))))", "GeoJson": { "type": "GeometryCollection", "geometries": [ { "type": "Polygon", "coordinates": [ [ [ 6.157837, 51.388923 ], [ 6.157837, 51.44716 ], [ 6.273193, 51.44716 ], [ 6.273193, 51.388923 ], [ 6.157837, 51.388923 ] ] ] }, { "type": "Polygon", "coordinates": [ [ [ 4.784546, 50.57626 ], [ 4.784546, 50.708634 ], [ 4.993286, 50.708634 ], [ 4.993286, 50.57626 ], [ 4.784546, 50.57626 ] ] ] }, { "type": "MultiPolygon", "coordinates": [ [ [ [ 4.855957, 51.225808 ], [ 4.887543, 51.232688 ], [ 4.921875, 51.20086 ], [ 4.888916, 51.179343 ], [ 4.864197, 51.191394 ], [ 4.855957, 51.225808 ] ] ], [ [ [ 4.625244, 51.224088 ], [ 4.680176, 51.268789 ], [ 4.762573, 51.175899 ], [ 4.614258, 51.086273 ], [ 4.625244, 51.224088 ] ] ] ] } ] }, "TileGuids": [], "MiniTileGuids": [], "SatelliteConstellations": [ "Sentinel1", "Sentinel2", "Landsat89" ], "Model": "Stratus2", "StorageMonths": 3, "ApiRequests": 5, "ImageFrequency": 2, "ReferenceDate": "2023-06-01", "From": "2023-06-01", "To": null, "SimulatedEuroUsage": null } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfTaskOrderEstimateResultDto" }, "example": { "Data": { "StorageMonths": 3, "ApiRequests": 5, "SatelliteConstellations": [ "Sentinel1", "Sentinel2", "Landsat89" ], "Model": "Stratus3", "CancellationDate": "2024-09-30", "AreaKm2": 931.61, "AreaKm2BeforeMinimum1Km2PerAoi": 930.65, "CurrentMonthCosts": { "CurrencyCode": "EUR", "TotalCost": 1000019.97, "ImageCost": 999999.99, "StorageCosts": 9.99, "ProcessingCreditCosts": 9.99, "PolygonCountSurcharge": 0.0 }, "RecurringCostsEstimate": { "CurrencyCode": "EUR", "TotalCost": 1000019.97, "ImageCost": 999999.99, "StorageCosts": 9.99, "ProcessingCreditCosts": 9.99, "PolygonCountSurcharge": 0.0 }, "IncludedProcessingUnits": 0.0, "RecurringProcessingUnits": 0.0, "Tiles": [], "MiniTiles": [], "Wkt": "GEOMETRYCOLLECTION (POLYGON ((8.675127 55.962046, 8.675127 55.963407, 8.679411 55.963407, 8.679411 55.962046, 8.675127 55.962046)), POLYGON ((8.472053 56.105382, 8.472053 56.337398, 8.948552 56.337398, 8.948552 56.105382, 8.472053 56.105382)), POLYGON ((8.678 55.948533, 8.678 56.068376, 8.878589 56.068376, 8.878589 55.948533, 8.678 55.948533)))", "ImageDates": [ "2023-06-01", "2023-06-03", "2023-06-05", "2023-06-07", "2023-06-09", "2023-06-11", "2023-06-13", "2023-06-15", "2023-06-17", "2023-06-19", "2023-06-21", "2023-06-23", "2023-06-25", "2023-06-27", "2023-06-29", "2023-07-01", "2023-07-03", "2023-07-05", "2023-07-07", "2023-07-09", "2023-07-11", "2023-07-13", "2023-07-15", "2023-07-17", "2023-07-19", "2023-07-21", "2023-07-23", "2023-07-25", "2023-07-27", "2023-07-29", "2023-07-31", "2023-08-02", "2023-08-04", "2023-08-06", "2023-08-08", "2023-08-10", "2023-08-12", "2023-08-14", "2023-08-16", "2023-08-18", "2023-08-20", "2023-08-22", "2023-08-24", "2023-08-26", "2023-08-28" ] }, "Succeeded": true, "Error": null } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/tasking/search/tiles": { "post": { "tags": [ "Tasking" ], "summary": "Search Orderable Tiles", "description": "Returns the orderable tiles intersecting Wkt. Each tile has an EPSG representing the projection of its underlying data, \nas well as a DataGeogWkt representing the tile after removing areas which always contain nodata values.", "operationId": "Tasking_SearchTiles", "requestBody": { "x-name": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskingOrderingTilesQuery" }, "example": { "Wkt": "POLYGON ((9.877893206725581 56.47856668238974, 10.196496722350581 56.47856668238974, 10.196496722350581 56.27782087776097, 9.877893206725581 56.27782087776097, 9.877893206725581 56.47856668238974))", "GeoJson": { "type": "Polygon", "coordinates": [ [ [ 9.877893206725581, 56.47856668238974 ], [ 10.196496722350581, 56.47856668238974 ], [ 10.196496722350581, 56.27782087776097 ], [ 9.877893206725581, 56.27782087776097 ], [ 9.877893206725581, 56.47856668238974 ] ] ] }, "TileGuids": null, "MiniTileGuids": null, "TileGuidForMiniTiles": null } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfTaskingTilesDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/tasking/orders/cancel": { "delete": { "tags": [ "Tasking" ], "summary": "Cancel Recurring Order", "description": "Cancel Recurring Order - NOT REVERSIBLE USING API. Potentially reversible by contacting info@clearsky.vision in due time.\nCancelling recurring taskorders may influence the actual price of other recurring taskorders.", "operationId": "Tasking_CancelTaskOrder", "parameters": [ { "name": "taskOrderGuid", "in": "query", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/tasking/tile/optimize": { "post": { "tags": [ "Tasking" ], "summary": "Optimize wkt to tiles", "description": "Submit a WKT GeometryCollection to get a cost-effective tile coverage. Best-effort optimization; exact optimality not guaranteed.", "operationId": "Tasking_OptimizeTiles", "requestBody": { "x-name": "command", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptimizeTilesCommand" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfTileOptimizeResultDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } }, "/api/tasking/orders/details": { "post": { "tags": [ "Tasking" ], "summary": "Get order details", "description": "Get details for specified tasking orders based on guids", "operationId": "Tasking_GetTaskOrdersByGuids", "requestBody": { "x-name": "body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskOrderGuidsBody" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfTaskOrderDetailedListDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResultOfDictionaryOfStringAndListOfString" }, "example": { "Data": { "Property": [ "Property must " ] }, "Succeeded": false, "Error": { "Message": "One or more validation errors occurred.", "Code": 992 } } } } } } } } }, "components": { "schemas": { "ServiceResultOfApiKeyLimitedDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ApiKeyLimitedDto" } ] } } } ] }, "ApiKeyLimitedDto": { "type": "object", "additionalProperties": false, "properties": { "TenantId": { "type": "string" }, "EuroOverdraftLimit": { "type": "integer", "format": "int32" }, "EuroBalanceCap": { "type": "integer", "format": "int32" }, "MaxConcurrentConnections": { "type": "integer", "format": "int32" }, "MaxCompositeAreaKm2": { "type": "integer", "format": "int32" }, "MaxTotalBands": { "type": "integer", "format": "int32" } } }, "ServiceResult": { "type": "object", "additionalProperties": false, "properties": { "Succeeded": { "type": "boolean" }, "Error": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ServiceError" } ] } } }, "ServiceError": { "type": "object", "description": "All errors contained in ServiceResult objects must return an error of this type\nError codes allow the caller to easily identify the received error and take action.\nError messages allow the caller to easily show error messages to the end user.", "additionalProperties": false, "properties": { "Message": { "type": "string", "description": "Human readable error message" }, "Code": { "type": "integer", "description": "Machine readable error code", "format": "int32" } } }, "ServiceResultOfDictionaryOfStringAndListOfString": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "type": "object", "nullable": true, "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } ] }, "ServiceResultOfApiKeySettingsDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ApiKeySettingsDto" } ] } } } ] }, "ApiKeySettingsDto": { "type": "object", "additionalProperties": false, "properties": { "ServiceSettings": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyServiceSettingDto" } } } }, "ApiKeyServiceSettingDto": { "type": "object", "additionalProperties": false, "properties": { "SettingName": { "type": "string" }, "SettingValue": { "type": "string" } } }, "ServiceResultOfBillingSummaryDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BillingSummaryDto" } ] } } } ] }, "BillingSummaryDto": { "type": "object", "additionalProperties": false, "properties": { "EuroCreditBalance": { "type": "number", "format": "decimal" }, "EuroOverdraftLimit": { "type": "number", "format": "decimal" }, "EuroBalanceCap": { "type": "number", "format": "decimal" }, "EuroAvailableToSpend": { "type": "number", "format": "decimal" }, "ProcessingUnitBalance": { "type": "number", "format": "decimal" }, "CurrentMonthCosts": { "$ref": "#/components/schemas/BillingCostsDto" }, "RecurringCostsEstimate": { "$ref": "#/components/schemas/BillingCostsDto" } } }, "BillingCostsDto": { "type": "object", "additionalProperties": false, "properties": { "TotalCostEuro": { "type": "number", "format": "decimal" }, "ImageCostEuro": { "type": "number", "format": "decimal" }, "StorageCostEuro": { "type": "number", "format": "decimal" }, "ProcessingCreditCostEuro": { "type": "number", "format": "decimal" }, "PolygonCountSurchargeEuro": { "type": "number", "format": "decimal" } } }, "ServiceResultOfBillingOrdersListDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BillingOrdersListDto" } ] } } } ] }, "BillingOrdersListDto": { "type": "object", "additionalProperties": false, "properties": { "Year": { "type": "integer", "format": "int32" }, "Month": { "type": "integer", "format": "int32" }, "Orders": { "type": "array", "items": { "$ref": "#/components/schemas/BillingOrderCostRowDto" } } } }, "BillingOrderCostRowDto": { "type": "object", "additionalProperties": false, "properties": { "TaskOrderId": { "type": "integer", "format": "int32" }, "Guid": { "type": "string", "format": "guid" }, "TotalCostEuro": { "type": "number", "format": "decimal" }, "ImageCostEuro": { "type": "number", "format": "decimal" }, "StorageCostEuro": { "type": "number", "format": "decimal" }, "ProcessingCreditCostEuro": { "type": "number", "format": "decimal" }, "PolygonCountSurchargeEuro": { "type": "number", "format": "decimal" }, "SpecialImageDiscountPercentage": { "type": "number", "format": "decimal" }, "CreatedDate": { "type": "string", "format": "date-time" } } }, "ServiceResultOfBillingTransactionsListDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BillingTransactionsListDto" } ] } } } ] }, "BillingTransactionsListDto": { "type": "object", "additionalProperties": false, "properties": { "Year": { "type": "integer", "format": "int32" }, "Month": { "type": "integer", "format": "int32" }, "Transactions": { "type": "array", "items": { "$ref": "#/components/schemas/BillingTransactionRowDto" } } } }, "BillingTransactionRowDto": { "type": "object", "additionalProperties": false, "properties": { "TransactionName": { "type": "string" }, "CreatedDate": { "type": "string", "format": "date-time" }, "EuroAmount": { "type": "number", "format": "decimal" }, "TransactionComplete": { "type": "boolean" }, "PaymentType": { "type": "string" } } }, "ServiceResultOfVoucherRedeemResultDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VoucherRedeemResultDto" } ] } } } ] }, "VoucherRedeemResultDto": { "type": "object", "additionalProperties": false, "properties": { "VoucherId": { "type": "integer", "format": "int32" }, "ApiKeyId": { "type": "integer", "format": "int32" }, "AmountEurApplied": { "type": "number", "format": "decimal" }, "TransactionId": { "type": "integer", "format": "int32" }, "RedemptionId": { "type": "integer", "format": "int32" }, "RedemptionsCount": { "type": "integer", "format": "int32" }, "MaxRedemptions": { "type": "integer", "format": "int32" }, "Status": { "type": "string" } } }, "RedeemVoucherCommand": { "type": "object", "additionalProperties": false, "properties": { "Code": { "type": "string" } } }, "ServiceResultOfSatelliteMergedAreaDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SatelliteMergedAreaDto" } ] } } } ] }, "SatelliteMergedAreaDto": { "type": "object", "additionalProperties": false, "properties": { "Geog": { "type": "string", "description": "Geography in wkt format, srid 4326" }, "SatelliteMergedImageDates": { "type": "array", "description": "Image dates that are present in all SatelliteZone intersected by Geog", "items": { "$ref": "#/components/schemas/SatelliteMergedImageDateDto" } } } }, "SatelliteMergedImageDateDto": { "type": "object", "additionalProperties": false, "properties": { "ImageDate": { "type": "string", "format": "date-time" } } }, "GetCompositeSatelliteImagesByGeogWktQuery": { "type": "object", "additionalProperties": false, "properties": { "BoundingBoxWkt": { "type": "string", "deprecated": true, "x-deprecatedMessage": "use GeogWkt", "nullable": true }, "GeogWkt": { "type": "string", "nullable": true }, "From": { "type": "string", "format": "date-time", "nullable": true }, "Until": { "type": "string", "format": "date-time", "nullable": true } } }, "ServiceResultOfSatelliteImagerySearchResultsDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SatelliteImagerySearchResultsDto" } ] } } } ] }, "SatelliteImagerySearchResultsDto": { "type": "object", "additionalProperties": false, "properties": { "ModelImageDates": { "type": "array", "description": "Satellite Imagery, by model and satellite constellations", "items": { "$ref": "#/components/schemas/SatelliteImagerySearchByModelResultsDto" } } } }, "SatelliteImagerySearchByModelResultsDto": { "type": "object", "additionalProperties": false, "properties": { "Model": { "type": "string" }, "SatelliteConstellations": { "type": "array", "items": { "$ref": "#/components/schemas/SatelliteConstellation" } }, "DatesByGeog": { "type": "array", "items": { "$ref": "#/components/schemas/GeogDatesDto" } } } }, "SatelliteConstellation": { "type": "string", "description": "", "x-enumNames": [ "Sentinel1", "Sentinel2", "Landsat89", "Sentinel3OLCI", "Sentinel3SLSTR", "WFIAmazonia", "MUXCBERS4", "AWFICBERS4", "MUXCBERS4A", "WFICBERS4A", "TESTCONSTELLATION", "Sentinel2L1" ], "enum": [ "Sentinel1", "Sentinel2", "Landsat89", "Sentinel3OLCI", "Sentinel3SLSTR", "WFIAmazonia", "MUXCBERS4", "AWFICBERS4", "MUXCBERS4A", "WFICBERS4A", "TESTCONSTELLATION", "Sentinel2L1" ] }, "GeogDatesDto": { "type": "object", "additionalProperties": false, "properties": { "Wkt": { "type": "string" }, "Dates": { "type": "array", "items": { "type": "string", "format": "date" } } } }, "SearchTaskedAvailableSatelliteImageryQuery": { "type": "object", "additionalProperties": false, "properties": { "Wkt": { "type": "string", "nullable": true }, "GeoJson": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/GeoJsonGeometryDto" } ] }, "From": { "type": "string", "format": "date-time", "nullable": true }, "Until": { "type": "string", "format": "date-time", "nullable": true } } }, "GeoJsonGeometryDto": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string" }, "coordinates": { "nullable": true }, "geometries": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/GeoJsonGeometryDto" } } } }, "CreateSatelliteImageCompositeCommand": { "type": "object", "additionalProperties": false, "properties": { "Wkt": { "type": "string", "description": "Geometry in WKT format. ", "nullable": true }, "GeoJson": { "description": "Geometry in GeoJSON format.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/GeoJsonGeometryDto" } ] }, "Date": { "type": "string", "description": "Date for composite image", "format": "date-time" }, "Resolution": { "type": "integer", "description": "10m, 20m, 40m, 80m, 160m, 320m, 640m, 1280m SatelliteImageResolution", "format": "int32" }, "EpsgProjection": { "type": "integer", "description": "any epsg number, e.g. 4326 for WGS84, 3857 for Web Mercator. EPSG is NOT validated against possible projections as of 2023-09, in general all pyproj CRS are available.\nUsing EpsgProjection = 47000 will auto select the most fitting UTM EPSG projection.", "format": "int32" }, "FileType": { "description": "tif SatelliteImageFileType", "oneOf": [ { "$ref": "#/components/schemas/SatelliteImageFileType" } ] }, "PixelSelectionMode": { "description": "intersect, contained SatelliteImagePixelSelectionMode", "oneOf": [ { "$ref": "#/components/schemas/SatelliteImagePixelSelectionMode" } ] }, "DataType": { "description": "INT16, UINT8 SatelliteImageDataType", "oneOf": [ { "$ref": "#/components/schemas/SatelliteImageDataType" } ] }, "UtmDataSelectionMode": { "description": "single_utm_fully_covered, single_utm, combined_utm SatelliteImageUtmDataSelectionMode", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SatelliteImageUtmDataSelectionMode" } ] }, "SatelliteConstellations": { "type": "array", "description": "Sentinel1, Sentinel2, Landsat89, Sentinel3OLCI, Sentinel3SLSTR, WFIAmazonia, MUXCBERS4, AWFICBERS4, MUXCBERS4A, WFICBERS4A. SatelliteConstellation", "nullable": true, "items": { "$ref": "#/components/schemas/SatelliteConstellation" } }, "Model": { "description": "For documentation on available models, visit https://api.clearsky.vision/docs/index.html?url=/api/specification.json#tag/Tasking/operation/Tasking_GetTaskingModels ", "oneOf": [ { "$ref": "#/components/schemas/PredictionModel" } ] }, "UtmGridForcePixelResolutionSize": { "type": "boolean", "description": "true - Forces pixels to always be Resolution size in meters, even when reprojecting some pixels. The reprojection errors manifest as e.g. a twisted image instead of pixel size differences.\nfalse - Pixel size in meters may be slightly different from Resolution, even when reprojecting some pixels. The reprojection errors manifest as slightly modified pixel sizes (e.g. 9.99m instead of 10m)." }, "Bandnames": { "type": "string", "description": "Band options include ('rgb', 'all', or a combination of the following bands: 'B2', 'B3', 'B4', 'B5', 'B6', 'B7', 'B8', 'B8A', 'B11', 'B12'). \nIt is also possible to pre-compute remote sensing indices in the form (Band1 - Band2) / (Band1 + Band2)\nfor instance NDVI would be written as [B8_B4] and will be calculated as (B8 - B4) / (B8 + B4).\n\"B2, B7, B8, B5, [B8_B4]\" is an example containing 4 bands followed by a calculated index in the resulting file." }, "OldPixelSelectionMode": { "type": "boolean", "description": "Use old way of determining pixels to be used for pixelselectionmode, better for wall-to-wall images in non-utm epsg" }, "AllowPartialImage": { "type": "boolean", "description": "Used to determine if all zones intersected should have an available image before we process the composite" }, "AutomaticOrderCreation": { "type": "boolean", "description": "If the request would fail with \"Requested Area and Date are not covered by an order\", code 1006, instead queue request for automatic tasking order creation." }, "UploadUrl": { "type": "string", "description": "URL to make PUT request with resulting file. File will be uploaded to URL instead of being returned", "nullable": true } } }, "SatelliteImageFileType": { "type": "string", "description": "", "x-enumNames": [ "tif" ], "enum": [ "tif" ] }, "SatelliteImagePixelSelectionMode": { "type": "string", "description": "", "x-enumNames": [ "intersect", "contained" ], "enum": [ "intersect", "contained" ] }, "SatelliteImageDataType": { "type": "string", "description": "", "x-enumNames": [ "INT16", "UINT8" ], "enum": [ "INT16", "UINT8" ] }, "SatelliteImageUtmDataSelectionMode": { "type": "string", "description": "", "x-enumNames": [ "single_utm_fully_covered", "combined_utm", "single_utm" ], "enum": [ "single_utm_fully_covered", "combined_utm", "single_utm" ] }, "PredictionModel": { "type": "string", "description": "", "x-enumNames": [ "Stratus2", "Jerry", "Gust", "Stratus2NoSnow", "NimbusTest", "Nimbus", "StratusOptimized", "Stratus3", "Cumulus", "NimbusNDVI", "Cirrus", "Blurry", "Stratus2Fast" ], "enum": [ "Stratus2", "Jerry", "Gust", "Stratus2NoSnow", "NimbusTest", "Nimbus", "StratusOptimized", "Cumulus", "NimbusNDVI", "Cirrus", "Blurry", "Stratus2Fast" ] }, "CreateSatelliteImageMiniTileCommand": { "type": "object", "additionalProperties": false, "properties": { "MiniTileGuid": { "type": "string", "description": "Guid to identify the mini-tile. ", "format": "guid" }, "Date": { "type": "string", "description": "Date for mini-tile image", "format": "date-time" }, "SatelliteConstellations": { "type": "array", "description": "Sentinel1, Sentinel2, Landsat89, Sentinel3OLCI, Sentinel3SLSTR, WFIAmazonia, MUXCBERS4, AWFICBERS4, MUXCBERS4A, WFICBERS4A. SatelliteConstellation", "items": { "$ref": "#/components/schemas/SatelliteConstellation" } }, "Model": { "description": "For documentation on available models, visit https://api.clearsky.vision/docs/index.html?url=/api/specification.json#tag/Tasking/operation/Tasking_GetTaskingModels ", "oneOf": [ { "$ref": "#/components/schemas/PredictionModel" } ] }, "Level": { "type": "integer", "description": "Optional: 1 = Level-1, 2 = Level-2. Defaults to 2 if omitted.", "format": "int32", "nullable": true }, "Harmonize": { "type": "boolean", "description": "Optional: apply harmonization for models that support not providing harmonized data. Defaults to true if omitted.", "nullable": true }, "ClipReflectance": { "type": "boolean", "nullable": true }, "UploadUrl": { "type": "string", "description": "URL to make PUT request with resulting file. File will be uploaded to URL instead of being returned", "nullable": true } } }, "CreateSatelliteImageTileCommand": { "type": "object", "additionalProperties": false, "properties": { "TileGuid": { "type": "string", "description": "Guid to identify the tile. ", "format": "guid" }, "Date": { "type": "string", "description": "Date for mini-tile image", "format": "date-time" }, "SatelliteConstellations": { "type": "array", "description": "Sentinel1, Sentinel2, Landsat89, Sentinel3OLCI, Sentinel3SLSTR, WFIAmazonia, MUXCBERS4, AWFICBERS4, MUXCBERS4A, WFICBERS4A. SatelliteConstellation", "items": { "$ref": "#/components/schemas/SatelliteConstellation" } }, "Model": { "description": "For documentation on available models, visit https://api.clearsky.vision/docs/index.html?url=/api/specification.json#tag/Tasking/operation/Tasking_GetTaskingModels ", "oneOf": [ { "$ref": "#/components/schemas/PredictionModel" } ] }, "Level": { "type": "integer", "description": "Optional: 1 = Level-1, 2 = Level-2. Defaults to 2 if omitted.", "format": "int32", "nullable": true }, "Harmonize": { "type": "boolean", "description": "Optional: apply harmonization for models that support not providing harmonized data. Defaults to true if omitted.", "nullable": true }, "ClipReflectance": { "type": "boolean", "nullable": true }, "UploadUrl": { "type": "string", "description": "URL to make PUT request with resulting file. File will be uploaded to URL instead of being returned", "nullable": true } } }, "ServiceResultOfSatelliteMergedAreaAvailableDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SatelliteMergedAreaAvailableDto" } ] } } } ] }, "SatelliteMergedAreaAvailableDto": { "type": "object", "additionalProperties": false, "properties": { "IntersectedActiveZones": { "type": "boolean", "description": "Boolean set to true if any tile area intersecting polygon was found" }, "IntersectedActiveZonesUtmEpsg": { "type": "boolean", "description": "Boolean set to true if any tile area for requested Utm Zone intersecting polygon was found" }, "FullyAvailable": { "type": "boolean", "description": "Boolean set to true if all underlying areas intersecting polygon contain satelliteimage with requested date" }, "UncertaintyAvailable": { "type": "boolean", "description": "Boolean set to true if all underlying areas intersecting polygon contain uncertainty image with requested date" }, "PartiallyAvailable": { "type": "boolean", "description": "Boolean set to true if some underlying areas intersecting polygon contain satelliteimage with requested date" }, "PartiallyUncertaintyAvailable": { "type": "boolean", "description": "Boolean set to true if some underlying areas intersecting polygon contain uncertainty image with requested date" }, "PolygonInDataArea": { "type": "boolean", "description": "Boolean set to true if polygon is in an area with data (e.g. not completely in water)" }, "DataAvailableForUser": { "type": "boolean", "description": "Boolean set to false if data access for specified date and area has been restricted. Contact for more information." }, "DataOnZoneDataFrequencyDate": { "type": "boolean", "description": "Boolean set to false if specified date is not on a date that is supposed to have data, e.g. every second day." }, "AllImagesPredicted": { "type": "boolean", "description": "Boolean set to false if any underlying tile has not had an image predicted for date when it should have." }, "AnyImageWithinStorageMonths": { "type": "boolean", "description": "Boolean set to false if no images were available due to storage being expired" }, "OrdersCoverPolygon": { "type": "boolean", "description": "Boolean set to false if union of ordered areas did not cover the requested Polygon" } } }, "SatelliteImageCompositeAvailableQuery": { "type": "object", "additionalProperties": false, "properties": { "Wkt": { "type": "string", "description": "Geometry in WKT format. ", "nullable": true }, "GeoJson": { "description": "Geometry in GeoJSON format.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/GeoJsonGeometryDto" } ] }, "Date": { "type": "string", "format": "date-time" }, "UtmDataSelectionMode": { "description": "single_utm_fully_covered, single_utm, combined_utm SatelliteImageUtmDataSelectionMode", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SatelliteImageUtmDataSelectionMode" } ] }, "SatelliteConstellations": { "type": "array", "description": "Sentinel1, Sentinel2, Landsat89, Sentinel3OLCI, Sentinel3SLSTR, WFIAmazonia, MUXCBERS4, AWFICBERS4, MUXCBERS4A, WFICBERS4A. SatelliteConstellation", "nullable": true, "items": { "$ref": "#/components/schemas/SatelliteConstellation" } }, "Model": { "description": "For documentation on available models, visit https://api.clearsky.vision/docs/index.html?url=/api/specification.json#tag/Tasking/operation/Tasking_GetTaskingModels ", "oneOf": [ { "$ref": "#/components/schemas/PredictionModel" } ] }, "EpsgProjection": { "type": "integer", "description": "any epsg number, e.g. 4326 for WGS84, 3857 for Web Mercator. EPSG is NOT validated against possible projections as of 2023-09, in general all pyproj CRS are available.", "format": "int32" }, "Bandnames": { "type": "string", "description": "Various bandnames may have specific rules regarding availability" } } }, "ServiceResultOfSatellitePreviewEstimateDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SatellitePreviewEstimateDto" } ] } } } ] }, "SatellitePreviewEstimateDto": { "type": "object", "additionalProperties": false, "properties": { "SlowTimeEstimateSeconds": { "type": "integer", "format": "int32" }, "FastTimeEstimateSeconds": { "type": "integer", "format": "int32" }, "AreaEstimateKm2": { "type": "number", "format": "decimal" }, "FileSizeEstimateMB": { "type": "number", "format": "double" }, "ProcessingUnitEstimate": { "type": "number", "format": "decimal" } } }, "SatelliteImageCompositeEstimateQuery": { "type": "object", "additionalProperties": false, "properties": { "Wkt": { "type": "string", "description": "Geometry in WKT format. ", "nullable": true }, "GeoJson": { "description": "Geometry in GeoJSON format.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/GeoJsonGeometryDto" } ] }, "MiniTileGuid": { "type": "string", "description": "Guid identifying mini-tile", "format": "guid", "nullable": true }, "TileGuid": { "type": "string", "description": "Guid identifying tile", "format": "guid", "nullable": true } } }, "ServiceResultOfSatelliteProductSatelliteCompositeDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SatelliteProductSatelliteCompositeDto" } ] } } } ] }, "SatelliteProductSatelliteCompositeDto": { "type": "object", "additionalProperties": false, "properties": { "SatelliteProductsForComposite": { "type": "array", "items": { "$ref": "#/components/schemas/SatelliteProductLimitedDto" } } } }, "SatelliteProductLimitedDto": { "type": "object", "additionalProperties": false, "properties": { "SatelliteConstellation": { "$ref": "#/components/schemas/SatelliteConstellation" }, "ProductGeogWkt": { "type": "string" }, "ImageDate": { "type": "string", "format": "date-time" } } }, "GetSatelliteProductsByCompositeQuery": { "type": "object", "additionalProperties": false, "properties": { "GeogWkt": { "type": "string", "description": "Geog in epsg 4326 to find relevant intersecting satelliteproducts for composite" }, "From": { "type": "string", "description": "Inclusive From date to match SatelliteProducts", "format": "date-time" }, "Until": { "type": "string", "description": "Inclusive Until date to match SatelliteProducts", "format": "date-time" } } }, "ServiceResultOfSatelliteAcquisitionPlansDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SatelliteAcquisitionPlansDto" } ] } } } ] }, "SatelliteAcquisitionPlansDto": { "type": "object", "additionalProperties": false, "properties": { "Plans": { "type": "array", "items": { "$ref": "#/components/schemas/DateAcquisitionPlansDto" } } } }, "DateAcquisitionPlansDto": { "type": "object", "additionalProperties": false, "properties": { "Date": { "type": "string", "format": "date-time" }, "AcquisitionPlans": { "type": "array", "items": { "$ref": "#/components/schemas/SatelliteAcquisitionPlanDto" } } } }, "SatelliteAcquisitionPlanDto": { "type": "object", "additionalProperties": false, "properties": { "Satellite": { "$ref": "#/components/schemas/Satellite" }, "AcquisitionStatus": { "type": "string" }, "PublicationStatus": { "type": "string" }, "Wkt": { "type": "string" } } }, "Satellite": { "type": "string", "description": "", "x-enumNames": [ "S1A", "S1B", "S2A", "S2B", "L8", "L9", "S2C" ], "enum": [ "S1A", "S1B", "S2A", "S2B", "L8", "L9", "S2C" ] }, "GetSatelliteProductsAcquisitionPlansByGeographyQuery": { "type": "object", "additionalProperties": false, "properties": { "GeogWkt": { "type": "string", "description": "Geog in epsg 4326 to find relevant intersecting satelliteproduct acquisition plans" } } }, "ServiceResultOfTaskingModelListDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TaskingModelListDto" } ] } } } ] }, "TaskingModelListDto": { "type": "object", "additionalProperties": false, "properties": { "TaskingModels": { "type": "array", "items": { "$ref": "#/components/schemas/TaskingModelDto" } } } }, "TaskingModelDto": { "type": "object", "additionalProperties": false, "properties": { "Model": { "type": "string" }, "SupportedSatelliteConstellations": { "type": "array", "items": { "$ref": "#/components/schemas/TaskingSatelliteConstellationRequiredDto" } } } }, "TaskingSatelliteConstellationRequiredDto": { "type": "object", "additionalProperties": false, "properties": { "SatelliteConstellation": { "$ref": "#/components/schemas/SatelliteConstellation" }, "Optional": { "type": "boolean" } } }, "ServiceResultOfTaskOrderListDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TaskOrderListDto" } ] } } } ] }, "TaskOrderListDto": { "type": "object", "additionalProperties": false, "properties": { "TaskOrders": { "type": "array", "items": { "$ref": "#/components/schemas/TaskOrderPublicDto" } } } }, "TaskOrderPublicDto": { "type": "object", "additionalProperties": false, "properties": { "TaskOrderGuid": { "type": "string", "format": "guid" }, "BillingCycle": { "$ref": "#/components/schemas/BillingCycle" }, "OrderingProcessStatus": { "$ref": "#/components/schemas/ProcessStatus" }, "StorageMonths": { "type": "integer", "format": "int32" }, "ApiRequests": { "type": "integer", "format": "int32" }, "TaskOrderAreaKm2": { "type": "number", "format": "double" }, "SatelliteConstellations": { "type": "array", "items": { "$ref": "#/components/schemas/SatelliteConstellation" } }, "Model": { "type": "string" }, "ImageFrequency": { "type": "integer", "format": "int32", "nullable": true }, "ReferenceDate": { "type": "string", "format": "date", "nullable": true }, "From": { "type": "string", "format": "date" }, "To": { "type": "string", "format": "date", "nullable": true }, "Tiles": { "type": "array", "items": { "type": "string", "format": "guid" } }, "MiniTiles": { "type": "array", "items": { "type": "string", "format": "guid" } }, "Wkt": { "type": "string", "nullable": true }, "CreatedDate": { "type": "string", "format": "date-time" }, "IsAutomaticOrder": { "type": "boolean" } } }, "BillingCycle": { "type": "string", "description": "", "x-enumNames": [ "Monthly", "Yearly" ], "enum": [ "Monthly", "Yearly" ] }, "ProcessStatus": { "type": "string", "description": "", "x-enumNames": [ "Unassigned", "Idle", "Working", "Failure", "Success", "Destroyed", "ToBeDestroyed", "PostProcess", "Ignore", "Initialize", "Ready", "Review", "PostInitialize", "PostSuccess", "UpToDate", "Processing", "Predicting", "ProcessingPredicting", "AwaitingSatelliteProducts", "Preparing", "Completed", "Canceled", "Ongoing", "Done" ], "enum": [ "Unassigned", "Idle", "Working", "Failure", "Success", "Destroyed", "ToBeDestroyed", "PostProcess", "Ignore", "Initialize", "Ready", "Review", "PostInitialize", "PostSuccess", "UpToDate", "Processing", "Predicting", "ProcessingPredicting", "AwaitingSatelliteProducts", "Preparing", "Completed", "Canceled", "Ongoing", "Done" ] }, "ServiceResultOfListOfGuid": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "type": "array", "nullable": true, "items": { "type": "string", "format": "guid" } } } } ] }, "ServiceResultOfTaskOrderPublicDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TaskOrderPublicDto" } ] } } } ] }, "CreateTaskOrderCommand": { "type": "object", "additionalProperties": false, "properties": { "Wkt": { "type": "string", "description": "Geometry in GEOMETRYCOLLECTION containing Polygons and/or MultiPolygons WKT format. The boundingbox of each geometry in collection will be used.", "nullable": true }, "GeoJson": { "description": "Geometry in GeoJSON format.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/GeoJsonGeometryDto" } ] }, "TileGuids": { "type": "array", "description": "Guids for tiles to order", "nullable": true, "items": { "type": "string", "format": "guid" } }, "MiniTileGuids": { "type": "array", "description": "Guids for mini tiles to order", "nullable": true, "items": { "type": "string", "format": "guid" } }, "SatelliteConstellations": { "type": "array", "description": "Satellites to incorporate data from", "items": { "$ref": "#/components/schemas/SatelliteConstellation" } }, "Model": { "description": "For documentation on available models, visit https://api.clearsky.vision/docs/index.html?url=/api/specification.json#tag/Tasking/operation/Tasking_GetTaskingModels ", "oneOf": [ { "$ref": "#/components/schemas/PredictionModel" } ] }, "StorageMonths": { "type": "integer", "description": "Number of months to keep the image data stored, past the initial month.", "format": "int32" }, "ApiRequests": { "type": "integer", "description": "How many times each AOI can be requested per month the image data is stored", "format": "int32" }, "ImageFrequency": { "type": "integer", "description": "Any date string yyyy-mm-dd. Reference date and ImageFrequency determine the imagery dates using the formula ((number of days between date and ReferenceDate) modulus ImageFrequency)\n\nOptional except for models that require specifying frequency", "format": "int32", "nullable": true }, "ReferenceDate": { "type": "string", "description": "Any date string yyyy-mm-dd. Reference date and ImageFrequency determine the imagery dates using the formula ((number of days between date and ReferenceDate) modulus ImageFrequency).\n\nOptional except for models that require specifying frequency", "format": "date", "nullable": true }, "From": { "type": "string", "description": "date string yyyy-mm-dd. Currently only year and month values are regarded, day must be set to the 1st in the month.", "format": "date" }, "To": { "type": "string", "description": "null/undefined for recurring subscription, or Any date string yyyy-mm-dd greater than or equal to StartMonth. Only year and month values are regarded.", "format": "date", "nullable": true }, "TileDeduplication": { "type": "boolean", "description": "True to deduplicate tile/mini-tile orders based on all previous tile/mini-tile orders" }, "GeometryTileOrdering": { "type": "boolean", "description": "True to order tiles using geometries with the Wkt or GeoJson parameters" } } }, "ServiceResultOfTaskOrderEstimateResultDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TaskOrderEstimateResultDto" } ] } } } ] }, "TaskOrderEstimateResultDto": { "type": "object", "additionalProperties": false, "properties": { "StorageMonths": { "type": "integer", "format": "int32" }, "ApiRequests": { "type": "integer", "format": "int32" }, "SatelliteConstellations": { "type": "array", "items": { "$ref": "#/components/schemas/SatelliteConstellation" } }, "Model": { "type": "string" }, "CancellationDate": { "type": "string", "format": "date" }, "AreaKm2": { "type": "number", "format": "decimal" }, "AreaKm2BeforeMinimum1Km2PerAoi": { "type": "number", "format": "decimal" }, "CurrentMonthCosts": { "$ref": "#/components/schemas/TaskOrderCostEstimateDto" }, "RecurringCostsEstimate": { "$ref": "#/components/schemas/TaskOrderCostEstimateDto" }, "IncludedProcessingUnits": { "type": "number", "format": "decimal" }, "RecurringProcessingUnits": { "type": "number", "format": "decimal" }, "Tiles": { "type": "array", "items": { "$ref": "#/components/schemas/TileCoverageDto" } }, "MiniTiles": { "type": "array", "items": { "type": "string", "format": "guid" } }, "Wkt": { "type": "string", "nullable": true }, "ImageDates": { "type": "array", "items": { "type": "string", "format": "date" } } } }, "TaskOrderCostEstimateDto": { "type": "object", "additionalProperties": false, "properties": { "CurrencyCode": { "type": "string" }, "TotalCost": { "type": "number", "format": "decimal" }, "ImageCost": { "type": "number", "format": "decimal" }, "StorageCosts": { "type": "number", "format": "decimal" }, "ProcessingCreditCosts": { "type": "number", "format": "decimal" }, "PolygonCountSurcharge": { "type": "number", "format": "decimal" } } }, "TileCoverageDto": { "type": "object", "additionalProperties": false, "properties": { "Guid": { "type": "string", "format": "guid" }, "TileNoDataDiscount": { "type": "number", "format": "double" } } }, "CreateTaskOrderEstimateCommand": { "type": "object", "additionalProperties": false, "properties": { "Wkt": { "type": "string", "description": "Geometry in GEOMETRYCOLLECTION containing Polygons and/or MultiPolygons WKT format. The boundingbox of each geometry in collection will be used.", "nullable": true }, "GeoJson": { "description": "Geometry in GeoJSON format.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/GeoJsonGeometryDto" } ] }, "TileGuids": { "type": "array", "description": "Guids for tiles to order", "nullable": true, "items": { "type": "string", "format": "guid" } }, "MiniTileGuids": { "type": "array", "description": "Guids for mini tiles to order", "nullable": true, "items": { "type": "string", "format": "guid" } }, "SatelliteConstellations": { "type": "array", "description": "Satellites to incorporate data from", "items": { "$ref": "#/components/schemas/SatelliteConstellation" } }, "Model": { "description": "For documentation on available models, visit https://api.clearsky.vision/docs/index.html?url=/api/specification.json#tag/Tasking/operation/Tasking_GetTaskingModels ", "oneOf": [ { "$ref": "#/components/schemas/PredictionModel" } ] }, "StorageMonths": { "type": "integer", "description": "Number of months to keep the image data stored, past the initial month.", "format": "int32" }, "ApiRequests": { "type": "integer", "description": "How many times each AOI can be requested per month the image data is stored", "format": "int32" }, "ImageFrequency": { "type": "integer", "description": "Any date string yyyy-mm-dd. Reference date and ImageFrequency determine the imagery dates using the formula ((number of days between date and ReferenceDate) modulus ImageFrequency)\n\nOptional except for models that require specifying frequency", "format": "int32", "nullable": true }, "ReferenceDate": { "type": "string", "description": "Any date string yyyy-mm-dd. Reference date and ImageFrequency determine the imagery dates using the formula ((number of days between date and ReferenceDate) modulus ImageFrequency).\n\nOptional except for models that require specifying frequency", "format": "date", "nullable": true }, "From": { "type": "string", "description": "date string yyyy-mm-dd. Currently only year and month values are regarded, day must be set to the 1st in the month.", "format": "date" }, "To": { "type": "string", "description": "null/undefined for recurring subscription, or Any date string yyyy-mm-dd greater than or equal to StartMonth. Only year and month values are regarded.", "format": "date", "nullable": true }, "SimulatedEuroUsage": { "type": "number", "description": "Used to simulate different account usage unit amounts, to better estimate costs of multiple orders. If not supplied actual usage will be used.", "format": "decimal", "nullable": true } } }, "ServiceResultOfTaskingTilesDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TaskingTilesDto" } ] } } } ] }, "TaskingTilesDto": { "type": "object", "additionalProperties": false, "properties": { "Tiles": { "type": "array", "items": { "$ref": "#/components/schemas/TaskingTileDto" } } } }, "TaskingTileDto": { "type": "object", "additionalProperties": false, "properties": { "Guid": { "type": "string", "description": "Tile Id", "format": "guid" }, "MiniTile": { "type": "boolean", "description": "Whether or not this tile is a regular tile or a mini tile" }, "Epsg": { "type": "string", "description": "EPSG used for data stored in tile" }, "DataGeogWkt": { "type": "string", "description": "Geography representing Tile, with nodata areas removed from geography. EPSG:4326" } } }, "TaskingOrderingTilesQuery": { "type": "object", "additionalProperties": false, "properties": { "Wkt": { "type": "string", "nullable": true }, "GeoJson": { "description": "Geometry in GeoJSON format.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/GeoJsonGeometryDto" } ] }, "TileGuids": { "type": "array", "description": "guids for tiles to search", "nullable": true, "items": { "type": "string", "format": "guid" } }, "MiniTileGuids": { "type": "array", "description": "guids for mini-tiles to search", "nullable": true, "items": { "type": "string", "format": "guid" } }, "TileGuidForMiniTiles": { "type": "string", "description": "Tile guid to retrieve mini-tiles for", "format": "guid", "nullable": true } } }, "ServiceResultOfTileOptimizeResultDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TileOptimizeResultDto" } ] } } } ] }, "TileOptimizeResultDto": { "type": "object", "additionalProperties": false, "properties": { "Tiles": { "type": "array", "items": { "type": "string", "format": "guid" } }, "MiniTiles": { "type": "array", "items": { "type": "string", "format": "guid" } } } }, "OptimizeTilesCommand": { "type": "object", "additionalProperties": false, "properties": { "Wkt": { "type": "string" } } }, "ServiceResultOfTaskOrderDetailedListDto": { "allOf": [ { "$ref": "#/components/schemas/ServiceResult" }, { "type": "object", "description": "A standard response for service calls.", "additionalProperties": false, "properties": { "Data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TaskOrderDetailedListDto" } ] } } } ] }, "TaskOrderDetailedListDto": { "type": "object", "additionalProperties": false, "properties": { "TaskOrders": { "type": "array", "items": { "$ref": "#/components/schemas/TaskOrderDetailedPublicDto" } } } }, "TaskOrderDetailedPublicDto": { "type": "object", "additionalProperties": false, "properties": { "TaskOrderGuid": { "type": "string", "format": "guid" }, "BillingCycle": { "$ref": "#/components/schemas/BillingCycle" }, "OrderingProcessStatus": { "$ref": "#/components/schemas/ProcessStatus" }, "StorageMonths": { "type": "integer", "format": "int32" }, "ApiRequests": { "type": "integer", "format": "int32" }, "TaskOrderAreaKm2": { "type": "number", "format": "double" }, "SatelliteConstellations": { "type": "array", "items": { "$ref": "#/components/schemas/SatelliteConstellation" } }, "Model": { "type": "string" }, "ImageFrequency": { "type": "integer", "format": "int32", "nullable": true }, "ReferenceDate": { "type": "string", "format": "date", "nullable": true }, "From": { "type": "string", "format": "date" }, "To": { "type": "string", "format": "date", "nullable": true }, "Tiles": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/TileRefWithWktDto" } }, "MiniTiles": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/TileRefWithWktDto" } }, "Wkt": { "type": "string", "nullable": true }, "CreatedDate": { "type": "string", "format": "date-time" }, "IsAutomaticOrder": { "type": "boolean" } } }, "TileRefWithWktDto": { "type": "object", "additionalProperties": false, "properties": { "Guid": { "type": "string", "format": "guid" }, "Wkt": { "type": "string" } } }, "TaskOrderGuidsBody": { "type": "object", "additionalProperties": false, "properties": { "Guids": { "type": "array", "items": { "type": "string", "format": "guid" } } } } } } }