swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Scenes API schemes: - https tags: - name: Scenes paths: /scenes: get: tags: - Scenes description: Returns a paginated list of scene resources. operationId: microsoftAzureScenesList produces: - application/json parameters: - in: query name: provider description: Provider name of scene data. required: true type: string - in: query name: partyId description: PartyId. required: true type: string - in: query name: boundaryId description: BoundaryId. required: true type: string - in: query name: source description: 'Source name of scene data, Available Values: Sentinel_2_L2A, Sentinel_2_L1C.' required: true type: string - in: query name: startDateTime description: 'Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ.' type: string format: date-time - in: query name: endDateTime description: 'Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ.' type: string format: date-time - in: query name: maxCloudCoveragePercentage description: Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0]. type: number format: double default: 100 maximum: 100 minimum: 0 - in: query name: maxDarkPixelCoveragePercentage description: Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0]. type: number format: double default: 100 maximum: 100 minimum: 0 - in: query name: imageNames description: List of image names to be filtered. type: array items: type: string collectionFormat: multi - in: query name: imageResolutions description: List of image resolutions in meters to be filtered. type: array items: format: double type: number collectionFormat: multi - in: query name: imageFormats description: List of image formats to be filtered. type: array items: type: string collectionFormat: multi - in: query name: maxPageSize description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50." type: integer format: int32 default: 50 maximum: 1000 minimum: 10 - in: query name: skipToken description: Skip token for getting next set of results. type: string - in: query name: api-version description: The requested API version required: true type: string responses: '200': description: Success schema: $ref: '#/definitions/SceneListResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-pageable: nextLinkName: nextLink x-ms-examples: Scenes_List: $ref: ./examples/Scenes_List.json summary: Microsoft Azure Get Scenes /scenes/downloadFiles: get: tags: - Scenes description: Downloads and returns file Stream as response for the given input filePath. operationId: microsoftAzureScenesDownload produces: - application/json - application/octet-stream parameters: - in: query name: filePath description: cloud storage path of scene file. required: true type: string - in: query name: api-version description: The requested API version required: true type: string responses: '200': description: Success schema: format: binary type: file default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: Scenes_Download: $ref: ./examples/Scenes_Download.json summary: Microsoft Azure Get Scenes Downloadfiles /scenes/satellite/ingest-data/{jobId}: put: tags: - Scenes description: Create a satellite data ingestion job. operationId: microsoftAzureScenesCreatesatellitedataingestionjob consumes: - application/json produces: - application/json parameters: - in: path name: jobId description: JobId provided by user. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: job description: Job parameters supplied by user. required: true schema: $ref: '#/definitions/SatelliteDataIngestionJob' responses: '202': description: Accepted schema: $ref: '#/definitions/SatelliteDataIngestionJob' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Scenes_CreateSatelliteDataIngestionJob: $ref: ./examples/Scenes_CreateSatelliteDataIngestionJob.json summary: Microsoft Azure Put Scenes Satellite Ingest Data Jobid get: tags: - Scenes description: Get a satellite data ingestion job. operationId: microsoftAzureScenesGetsatellitedataingestionjobdetails produces: - application/json parameters: - in: path name: jobId description: Id of the job. required: true type: string - in: query name: api-version description: The requested API version required: true type: string responses: '200': description: Success schema: $ref: '#/definitions/SatelliteDataIngestionJob' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: Scenes_GetSatelliteDataIngestionJobDetails: $ref: ./examples/Scenes_GetSatelliteDataIngestionJobDetails.json summary: Microsoft Azure Get Scenes Satellite Ingest Data Jobid /scenes/stac-collections/{collectionId}:search: post: tags: - Scenes description: Search for STAC features by collection id, bbox, intersecting geometry, start and end datetime. operationId: microsoftAzureScenesSearchfeatures consumes: - application/json produces: - application/json parameters: - in: path name: collectionId description: Collection Id to be searched. required: true type: string enum: - Sentinel_2_L2A - Sentinel_2_L1C x-ms-enum: name: collectionId modelAsString: true - in: query name: maxpagesize description: Maximum number of features needed (inclusive). Minimum = 1, Maximum = 100, Default value = 10. type: integer format: int32 default: 10 maximum: 100 minimum: 1 - in: query name: skip description: Skip token for getting next set of results. type: integer format: int32 maximum: 2147483647 minimum: 1 - in: query name: api-version description: The requested API version required: true type: string - in: body name: searchFeaturesQuery description: Query filters. required: true schema: $ref: '#/definitions/SearchFeaturesQuery' responses: '200': description: Success schema: $ref: '#/definitions/SearchFeaturesResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: Scenes_SearchFeatures: $ref: ./examples/Scenes_SearchFeatures.json summary: Microsoft Azure Post Scenes Stac Collections Collectionid:search /scenes/stac-collections/{collectionId}/features/{featureId}: get: tags: - Scenes description: Get a feature(SpatioTemporal Asset Catalog (STAC) Item) for given collection and feature id. operationId: microsoftAzureScenesGetstacfeature produces: - application/json parameters: - in: path name: collectionId description: Collection Id to be fetched. required: true type: string enum: - Sentinel_2_L2A - Sentinel_2_L1C x-ms-enum: name: collectionId modelAsString: true - in: path name: featureId description: Feature Id to be fetched. required: true type: string - in: query name: api-version description: The requested API version required: true type: string responses: '200': description: Success schema: $ref: '#/definitions/StacFeature' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: Scenes_GetStacFeature: $ref: ./examples/Scenes_GetStacFeature.json summary: Microsoft Azure Get Scenes Stac Collections Collectionid Features Featureid definitions: SatelliteDataIngestionJob: description: Schema of satellite data ingestion job. required: - boundaryId - endDateTime - partyId - source - startDateTime type: object properties: partyId: description: Party Id. minLength: 1 type: string boundaryId: description: The id of the boundary object for which satellite data is being fetched. minLength: 1 type: string startDateTime: format: date-time description: Start Date. type: string endDateTime: format: date-time description: End Date. type: string provider: $ref: '#/definitions/DataProvider' source: $ref: '#/definitions/Source' data: $ref: '#/definitions/SatelliteData' id: description: Unique job id. type: string readOnly: true status: description: "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'." type: string readOnly: true durationInSeconds: format: double description: Duration of the job in seconds. type: number readOnly: true message: description: Status message to capture more details of the job. type: string readOnly: true errorCode: description: Error Code when job failed. type: string readOnly: true createdDateTime: format: date-time description: 'Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string readOnly: true lastActionDateTime: format: date-time description: 'Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string readOnly: true startTime: format: date-time description: 'Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string readOnly: true endTime: format: date-time description: 'Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string readOnly: true name: description: Name to identify resource. maxLength: 100 minLength: 0 type: string description: description: Textual description of the resource. maxLength: 500 minLength: 0 type: string createdBy: description: Created by user/tenant id. type: string readOnly: true modifiedBy: description: Modified by user/tenant id. type: string readOnly: true properties: description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 ErrorResponse: description: An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document. type: object properties: error: $ref: '#/definitions/Error' traceId: description: Unique trace Id. type: string Scene: description: Schema of scene resource. type: object properties: sceneDateTime: format: date-time description: 'Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string provider: description: Data provider of the scene. maxLength: 100 minLength: 2 type: string source: description: Data source of the scene. maxLength: 100 minLength: 2 type: string imageFiles: description: Collection of image files. type: array items: $ref: '#/definitions/ImageFile' imageFormat: $ref: '#/definitions/ImageFormat' cloudCoverPercentage: format: double description: Cloud cover percentage of the scene. maximum: 100 minimum: 0 type: number darkPixelPercentage: format: double description: Dark pixel percentage of the scene. maximum: 100 minimum: 0 type: number ndviMedianValue: format: double description: Median of NDVI of the scene. maximum: 1 minimum: 0 type: number boundaryId: description: Boundary ID which belongs to the scene. maxLength: 100 minLength: 2 type: string partyId: description: Party ID which belongs to the scene. type: string id: description: Unique scene resource ID. type: string eTag: description: The ETag value to implement optimistic concurrency. type: string readOnly: true SearchFeaturesQuery: description: Search stac Features parameters. required: - endDateTime - startDateTime type: object properties: startDateTime: format: date-time description: Start datetime of the time interval in which to search for Features. type: string endDateTime: format: date-time description: End datetime of the time interval in which to search for Features. type: string intersects: $ref: '#/definitions/GeoJsonObject' bbox: description: "Only features that have a geometry that intersects the bounding box are selected.\r\nThe bounding box is provided as four numbers. The coordinate reference system of the values is WGS84 longitude/latitude." type: array items: format: double type: number featureIds: description: Array of feature ids to return. type: array items: type: string Source: description: Source of satellite data. enum: - Sentinel_2_L2A - Sentinel_2_L1C type: string x-ms-enum: name: Source modelAsString: true SearchFeaturesResponse: description: Paged response contains list of features and next property to get the next set of results. required: - features type: object properties: features: description: List of features. type: array items: $ref: '#/definitions/StacFeature' nextLink: description: "URL to do the POST request with same filters,\r\nto get next set of features." type: string readOnly: true SceneListResponse: description: Paged response contains list of requested objects and a URL link to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/Scene' skipToken: description: Token used in retrieving the next page. If null, there are no additional pages. type: string nextLink: description: Continuation link (absolute URI) to the next page of results in the list. type: string StacFeatureLink: description: "The Link object describes a relationship of this Feature with another entity.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#link-object." required: - href - rel type: object properties: href: description: The actual link in the format of an URL. minLength: 1 type: string rel: description: Relationship between the current document and the linked document. minLength: 1 type: string type: description: Media type of the referenced entity. type: string title: description: A human readable title to be used in rendered displays of the link. type: string ImageFormat: description: Supported image formats for scene resource. enum: - TIF type: string x-ms-enum: name: ImageFormat modelAsString: true StacFeatureAsset: description: "Schema of STAC Feature's Asset.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#asset-object." required: - href type: object properties: href: description: Link to the asset object. minLength: 1 type: string title: description: The displayed title for clients and users. type: string description: description: A description of the Asset providing additional details, such as how it was processed or created. type: string type: description: Media type of the asset. type: string roles: description: The semantic roles of the asset, similar to the use of rel in links. type: array items: type: string SatelliteData: description: Data Model for SatelliteIngestionJobRequest. type: object properties: imageNames: description: List of ImageNames. type: array items: type: string example: - NDVI imageFormats: description: 'List of ImageFormats. Available value: TIF.' type: array items: type: string example: - TIF imageResolutions: description: 'List of ImageResolutions in meters. Available values: 10, 20, 60.' type: array items: format: double type: number example: - 10 DataProvider: description: Provider of satellite data. enum: - Microsoft type: string x-ms-enum: name: DataProvider modelAsString: true StacFeature: description: "Schema of STAC Feature(Item).\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#item-fields." required: - assets - id - links - properties - stacVersion - type type: object properties: stacVersion: description: The STAC version the Feature implements. minLength: 1 type: string stacExtensions: description: A list of extensions the Feature implements. type: array items: type: string id: description: Provider identifier. Globally unique ID by Data provider. minLength: 1 type: string type: description: Type of the GeoJSON Object. It's value is always Feature. minLength: 1 type: string geometry: description: "Defines the full footprint of the asset represented by this item.\r\nIts a GeoJSON geometry." type: object bbox: description: Bounding box of the feature. type: array items: format: double type: number properties: description: A dictionary of additional metadata for the item. type: object links: description: List of link objects to resources and related URLs. type: array items: $ref: '#/definitions/StacFeatureLink' assets: description: Dictionary of asset objects, each with a unique key. type: object additionalProperties: $ref: '#/definitions/StacFeatureAsset' collection: description: The id of the STAC Collection this Feature references. type: string InnerError: description: Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document. type: object properties: code: description: Specific error code than was provided by the containing error. type: string innererror: $ref: '#/definitions/InnerError' ImageFile: description: Schema of image file resource. required: - name type: object properties: fileLink: description: Link of the image file. type: string name: description: Name of the image file. minLength: 1 type: string imageFormat: $ref: '#/definitions/ImageFormat' resolution: format: double description: Resolution of image file in meters. type: number GeoJsonObject: description: 'GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format.' required: - type type: object properties: type: $ref: '#/definitions/GeoJsonObjectType' discriminator: type GeoJsonObjectType: description: GeoJSON object type. enum: - Point - Polygon - MultiPolygon type: string x-ms-enum: name: GeoJsonObjectType modelAsString: true Error: description: An error from the Azure AgPlatform service. required: - code - message type: object properties: code: description: Server-defined set of error codes. minLength: 1 type: string message: description: Human-readable representation of the error. minLength: 1 type: string target: description: Target of the error. type: string details: description: Array of details about specific errors that led to this reported error. type: array items: $ref: '#/definitions/Error' innererror: $ref: '#/definitions/InnerError' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'