OneAtlas Data Pay-Per-Order API

components:
  parameters:
    ActivityId:
      description: >-
        The identifier of the activity. It is the correlation ID given to the
        ingestion/process/format order request.
      example: 799246d8-4172-11e8-b045-e7011a379ec4
      in: path
      name: activityId
      required: true
      schema:
        $ref: '#/components/schemas/Id'
    AssociatedDataType:
      description: The type of the associated data
      example: imageDimap
      in: path
      name: associatedDataType
      required: true
      schema:
        enum:
        - imageDimap
        - LUT
        type: string
    CatalogItemId:
      description: Identifier of an IDP catalog item (property `id` of a search result).
      example: 799246d8-4172-11e8-b045-e7011a379ec4
      in: path
      name: catalogItemId
      required: true
      schema:
        $ref: '#/components/schemas/Id'
    CorrelationID:
      description: >-
        CorrelationID is a header to track transaction identifier. If not
        specified, a new one is automatically generated.
      example: 799246d8-4172-11e8-b045-e7011a379ec4
      in: header
      name: X-Ads-Correlation-Id
      schema:
        $ref: '#/components/schemas/Id'
    ImageId:
      description: The identifier of the requested image
      example: 543246d8-2a72-11e8-b045-e7011a379452
      in: path
      name: imageId
      required: true
      schema:
        $ref: '#/components/schemas/Id'
    NotificationId:
      description: the identifier of the notification subscription
      example: 799246d8-4172-11e8-b045-e7011a379ec4
      in: path
      name: notificationId
      required: true
      schema:
        $ref: '#/components/schemas/Id'
    Priority:
      description: >-
        Priority is a header to sort activities. The highest priority is 1, the
        lowest is 9. If not specified, priority is set to 5.
      example: 799246d8-4172-11e8-b045-e7011a379ec4
      in: header
      name: X-Ads-Priority
      schema:
        $ref: '#/components/schemas/Id'
    ProcessID:
      description: The identifier of the process
      example: com.airbus.massive.ortho
      in: path
      name: processID
      required: true
      schema:
        type: string
    property-name:
      in: path
      name: propertyName
      description: The name of a queryable item property
      schema:
        type: string
      required: true
      example: processingLevel
    ResponseBufferFormatParameterHeader:
      description: |
        The encoding of the output image buffer.

        Accepted values are:
         - 'image/jp2' for jpeg2000
         - 'image/jpeg' for jpeg
         - 'image/png' for png
         - 'application/octet-stream' for raw
      in: header
      name: accept
      required: false
      schema:
        default: application/octet-stream
        enum:
        - image/jp2
        - image/jpeg
        - image/png
        - application/octet-stream
        example: image/jpeg
        type: string
    WorkspaceIdentifier:
      description: The workspace's identifier, that can be either its name or its id
      example: '"d1c80fd9-ddf6-4f6a-b6dc-4c8e60be61e8" or "MySuperWorkspace"'
      in: path
      name: workspace
      required: true
      schema:
        $ref: '#/components/schemas/WorkspaceIdentifier'
    acceptLanguageParameterHeader:
      description: the natural language that is preferred as a response to the request
      in: header
      name: Accept-Language
      required: false
      schema:
        type: string
        x-example: en-US
    contractId:
      description: >-
        It corresponds to an internal id for the customer contract - you will be
        provided the contractId
      in: path
      name: contractId
      required: true
      schema:
        type: string
    taskingId:
      description: The tasking id
      in: path
      name: taskingId
      required: true
      schema:
        type: string
    itemsPerPage:
      description: Amount of items per page, defaults to '10'
      in: query
      name: itemsPerPage
      schema:
        minimum: 1
        type: number
    orderId:
      description: The order id
      in: path
      name: orderId
      required: true
      schema:
        type: string
    CustomerReference:
      description: The Customer Reference
      in: path
      name: CustomerReference
      required: true
      schema:
        type: string
    page:
      description: Page number, defaults to '1'
      in: query
      name: page
      schema:
        minimum: 1
        type: number
    paymentId:
      description: The payment id
      in: path
      name: paymentId
      required: true
      schema:
        type: string
    productId:
      description: The product id
      in: path
      name: productId
      required: true
      schema:
        type: string
    subscriptionId:
      description: The subscription id
      in: path
      name: subscriptionId
      required: true
      schema:
        type: string
  responses:
    '400':
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: Bad request
    '401':
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: User is not authenticated
    '403':
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: User has not enough rights to consume the item
    '404':
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: Item not found in catalog or resource not found in item
    '405':
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: Method not allowed on this resource
    '429':
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: Too many requests
    '500':
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: Internal server error
    '503':
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: >-
        The server is currently unavailable (because it is overloaded or down
        for maintenance). Generally, this is a temporary state.
    UnauthorizedError:
      content:
        application/json:
          schema:
            type: string
      description: API key is missing or invalid
      headers:
        WWW-Authenticate:
          schema:
            type: string
  schemas:
    Activity:
      properties:
        _links:
          properties:
            cancel:
              allOf:
              - description: >-
                  See [Cancel
                  activity](#/paths/~1api~1v1~1activities~1{correlationId}~1cancel/post)
              - $ref: '#/components/schemas/Link'
            catalogItems:
              description: >-
                Resource id property (`resourceId`) is a catalog item id
                (`catalogItemId`). It can be used in all endpoints that need a
                `catalogItemId`.


                See [Search catalog items with
                opensearch](#/paths/~1api~1v1~1opensearch/get). See [Format
                catalog
                item](#/paths/~1api~1v1~1items~1{catalogItemId}~1format/post).
              items:
                $ref: '#/components/schemas/Link'
              type: array
              uniqueItems: true
            history:
              allOf:
              - description: >-
                  See [Get activity
                  stages](#/paths/~1api~1v1~1activities~1{correlationId}~1stages/get)
              - $ref: '#/components/schemas/Link'
            hold:
              allOf:
              - description: >-
                  See [Hold
                  activity](#/paths/~1api~1v1~1activities~1{correlationId}~1hold/post)
              - $ref: '#/components/schemas/Link'
            nexts:
              description: >-
                Next endpoints applicable to the resource when the activity is
                finished.
              items:
                $ref: '#/components/schemas/Link'
              type: array
              uniqueItems: true
            rerun:
              allOf:
              - description: >-
                  See [Run
                  activity](#/paths/~1api~1v1~1activities~1{correlationId}~1rerun/post)
              - $ref: '#/components/schemas/Link'
          readOnly: true
          type: object
        creationDate:
          description: The time when the activity was created
          format: datetime
          readOnly: true
          type: string
        endDate:
          description: >-
            The time when the activity was ended (copy of the date associated to
            the SUCCEEDED, CANCELED or FAILED stage)
          format: datetime
          readOnly: true
          type: string
        id:
          $ref: '#/components/schemas/Id'
        lastStageName:
          description: Name of the last completed stage
          type: string
        message:
          description: A free text (copy of the last stage message)
          readOnly: true
          type: string
        payload:
          description: The copy of the origin user request
          type: object
        priority:
          default: 5
          description: A priority indicator between 1 and 9. 1 is the highest.
          format: int
          maximum: 9
          minimum: 1
          type: number
        progress:
          default: 0
          description: A progress indicator between 0 and 100
          format: int
          maximum: 100
          minimum: 0
          type: number
        startDate:
          description: >-
            The time when the activity was started (date of the first stage that
            is not QUEUED)
          format: datetime
          readOnly: true
          type: string
        status:
          default: QUEUED
          description: Status of the activity (copy of the last stage status)
          enum:
          - QUEUED
          - RUNNING
          - ON_HOLD
          - CANCELED
          - WAITING_CANCEL
          - SUCCEEDED
          - FAILED
          - ARCHIVED
          type: string
        type:
          description: Type of activity
          enum:
          - ingestion
          - process
          - format
          - control
          - deliver
          type: string
        userId:
          allOf:
          - $ref: '#/components/schemas/Id'
          - description: >-
              The id of the user that is the origin of the activity (extracted
              from the X-Forwarded-User request header)
      type: object
    ActivitySearchOptions:
      properties:
        creationDate:
          description: The creation date or creation date range of the activity
          oneOf:
          - description: The creation date of the activity.
            example: '2017-08-29T00:00:00Z'
            format: date-time
            type: string
          - description: |-
              The creation dates range.

              Ranges are expressed as follow:
                - Comma to separate start value from end value
                - Start value or end value can be omitted (it means values are infinite)
                - Start with `[` means *start value is included*
                - Start with `]` means *start value is excluded*
                - End with `[` means *end value is included*
                - End with `]` means *end value is excluded*
            example: '[2017-08-29T00:00:00Z'
            format: date-time-range
            type: string
        endDate:
          description: >-
            The end date pf the activity (copy of the date associated to the
            SUCCEEDED or FAILED stage)
          format: datetime
          oneOf:
          - description: The end date of the activity.
            example: '2017-08-29T00:00:00Z'
            format: date-time
            type: string
          - description: |-
              The end dates range.

              Ranges are expressed as follow:
                - Comma to separate start value from end value
                - Start value or end value can be omitted (it means values are infinite)
                - Start with `[` means *start value is included*
                - Start with `]` means *start value is excluded*
                - End with `[` means *end value is included*
                - End with `]` means *end value is excluded*
            example: '[2017-08-29T00:00:00Z'
            format: date-time-range
            type: string
          type: string
        itemsPerPage:
          description: Number of requested items per page
          example: 50
          format: integer
          minimum: 1
          type: number
        payload:
          description: >-
            The copy of the origin user request. It could be the whole object or
            only some elements.
          oneOf:
          - description: The json object.
            example:
            - workspace: public
            type: object
          - description: String representation of the json object.
            example: '{"workspace":"public"}'
            type: string
        progress:
          description: A progress indicator between 0 and 100
          format: integer
          maximum: 100
          minimum: 0
          type: number
        sortBy:
          description: >-
            Unbounded list or parameters to sort by. The '+' indicates ascendant
            ordering, the '-' indicates descendant ordering. If not precised,
            default to '+'
          example: +startDate,-endDate
          type: string
        startDate:
          description: >-
            The start date of the activity (date of the first stage that is not
            QUEUED)
          format: datetime
          oneOf:
          - description: The start date of the activity.
            example: '2017-08-29T00:00:00Z'
            format: date-time
            type: string
          - description: |-
              The start dates range.

              Ranges are expressed as follow:
                - Comma to separate start value from end value
                - Start value or end value can be omitted (it means values are infinite)
                - Start with `[` means *start value is included*
                - Start with `]` means *start value is excluded*
                - End with `[` means *end value is included*
                - End with `]` means *end value is excluded*
            example: '[2017-08-29T00:00:00Z'
            format: date-time-range
            type: string
          type: string
        startIndex:
          description: The index of the first item present in the response
          example: 1
          format: integer
          minimum: 0
          type: number
        status:
          description: The status or status list (comma separated list) of the activity.
          enum:
          - QUEUED
          - RUNNING
          - ON_HOLD
          - CANCELED
          - WAITING_CANCEL
          - SUCCEEDED
          - FAILED
          - ARCHIVED
          type: string
        type:
          description: Type of activity
          enum:
          - ingestion
          - processing
          - formatting
          - delivering
          type: string
        userId:
          $ref: '#/components/schemas/Id'
      type: object
    ActivitySearchResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Activity'
          type: array
          uniqueItems: true
        itemsPerPage:
          description: Number of requested items per page
          example: 100
          format: integer
          minimum: 1
          type: number
        startIndex:
          description: The index of the first item present in the response
          example: 0
          format: integer
          minimum: 0
          type: number
        totalResults:
          description: The total number of activities
          example: 582
          format: integer
          maximum: 10000
          minimum: 0
          type: number
      type: object
    ActivitySmall:
      properties:
        _links:
          properties:
            history:
              allOf:
              - description: >-
                  See [Get activity
                  stages](#/paths/~1api~1v1~1activities~1{correlationId}~1stages/get)
              - $ref: '#/components/schemas/Link'
            monitoring:
              allOf:
              - description: >-
                  See [Get
                  activity](#/paths/~1api~1v1~1activities~1{correlationId}/get)
              - $ref: '#/components/schemas/Link'
          readOnly: true
          type: object
        message:
          description: A free text (copy of the last stage message)
          readOnly: true
          type: string
      type: object
    ActivityStage:
      properties:
        date:
          default: now
          description: Date of the stage
          example: '2018-06-12T11:24:31.254Z'
          format: datetime
          type: string
        message:
          type: string
        name:
          description: Name of the completed stage
          type: string
        status:
          description: Status of the activity
          enum:
          - QUEUED
          - RUNNING
          - ON_HOLD
          - CANCELED
          - WAITING_CANCEL
          - SUCCEEDED
          - FAILED
          - ARCHIVED
          type: string
        userId:
          allOf:
          - readOnly: true
          - $ref: '#/components/schemas/Id'
          - description: >-
              If exists, the id of the user that is the origin of the activity
              stage (extracted from the X-Forwarded-User request header)
      type: object
    ActivityStages:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ActivityStage'
          type: array
          uniqueItems: true
      type: object
    AcquisitionDate:
      type: object
      properties:
        startDate:
          type: string
          format: datetime
          pattern: ^yyyy-MM-dd'T'HH:mm:ss.SSS'Z$
          description: >-
            Defines the acquisition start date. The parameter can be set at any
            time. Note that if the parameter is set in the past, the value is
            replaced by the current date
        endDate:
          type: string
          format: datetime
          pattern: ^yyyy-MM-dd'T'HH:mm:ss.SSS'Z$
          description: Defines the acquisition end date
    AcqPerod:
      type: string
      pattern: ^yyyy-MM-dd'T'HH:mm:ss.SSS'Z yyyy-MM-dd'T'HH:mm:ss.SSS'Z$
      description: Defines the acquisition period
      format: datetime
    ApiError:
      properties:
        correlationId:
          $ref: '#/components/schemas/Id'
        hint:
          type: string
        internalCode:
          example: 400
          format: integer
          type: number
        message:
          type: string
        timestamp:
          description: Number of seconds since 01/01/1970
          example: 1530088354390
          format: integer
          type: number
      type: object
    contractId:
      description: >-
        It corresponds to an internal id for the customer contract. It will be
        provided to you.
      type: string
    NoSensorAvailable:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                example: ERR_NO_SENSOR_AVAILABLE
                type: string
              locator:
                example: UNKNOWN
                type: string
    TaskingAttempt:
      type: array
      items:
        type: object
        properties:
          mission:
            enum:
            - PLEIADESNEO
            type: string
          progTypes:
            type: array
            items:
              type: object
              properties:
                name:
                  type: string
                mission:
                  enum:
                  - PLEIADESNEO
                  type: string
                segments:
                  type: array
                  items:
                    $ref: '#/components/schemas/segment'
                available:
                  type: boolean
    ApiKey:
      properties:
        date:
          description: API key creation date in ISO 8601 format
          type: string
        description:
          description: A free-text human readable description of this API key
          type: string
        expirationDate:
          description: API key expiration date in ISO 8601 format
          type: string
        id:
          description: API Key identifier
          type: string
        secret:
          description: >-
            The API Key secret to be used to retrieve acces tokens. This field
            is only provided once, then the client should store this information
            in a secure place.
          type: string
      required:
      - id
      - description
      - date
      - expirationDate
      type: object
    ApiKeyPage:
      properties:
        items:
          description: API Keys
          items:
            $ref: '#/components/schemas/ApiKey'
          type: array
      type: object
    AssociatedDataLink:
      properties:
        content:
          example: GML MASK
          type: string
        mimeType:
          example: application/gml+xml
          type: string
        path:
          example: MASKS/ROI_SPOT6_P_201602011017034_SEN_2551123101_MSK.GML
          type: string
        title:
          example: LUT Mask
          type: string
        url:
          description: >-
            See [Get associated
            data](#/paths/~1api~1v1~1items~1{catalogItemId}~1images~1{imageId}~1associatedData~1{associatedDataType}~1data/get)
          example: >-
            https://view.foundation.api.oneatlas.com/api/v1/items/f494e323-e132-4aac-aad2-5123176a6800/images/5a277ab0-5315-4042-a676-267152d71e17/associatedData/LUT/data
          format: url
          type: string
      type: object
    CatalogItem:
      properties:
        _links:
          properties:
            buffer:
              allOf:
              - description: >-
                  See [Get
                  buffer](#/paths/~1api~1v1~1items~1{catalogItemId}~1images~1{imageId}~1buffer/post)
              - $ref: '#/components/schemas/Link'
            download:
              description: >
                See [Download formatted
                product](#/paths/~1api~1v1~1items~1{catalogItemId}~1download/get)
                and direct download links (gs, ftp)
              items:
                $ref: '#/components/schemas/Link'
              minItems: 1
              type: array
            imagesMetadata:
              description: >-
                See [Get catalog item image
                metadata](#/paths/~1api~1v1~1items~1{catalogItemId}~1images~1{imageId}~1metadata/get)
              items:
                $ref: '#/components/schemas/Link'
              minItems: 1
              type: array
            quicklook:
              allOf:
              - description: >-
                  See
                  [QuickLook](#/paths/~1api~1v1~1items~1{catalogItemId}~1quicklook/get)
              - $ref: '#/components/schemas/Link'
            thumbnail:
              allOf:
              - description: >-
                  See
                  [Thumbnail](#/paths/~1api~1v1~1items~1{catalogItemId}~1thumbnail/get)
              - $ref: '#/components/schemas/Link'
            wms:
              allOf:
              - description: >
                  See [WMS OTF
                  visualization](#/paths/~1api~1v1~1items~1{catalogItemId}~1wms/get)
                  and [WMS
                  visualization](#/paths/~1api~1v1~1items~1{catalogItemId}~1images~1{imageId}~1wms/get)
              - $ref: '#/components/schemas/Link'
            wmts:
              allOf:
              - description: >
                  See [WMTS OTF
                  visualization](#/paths/~1api~1v1~1items~1{catalogItemId}~1wmts/get)
                  and [WMTS
                  visualization](#/paths/~1api~1v1~1items~1{catalogItemId}~1images~1{imageId}~1wmts/get)
              - $ref: '#/components/schemas/Link'
          readOnly: true
          type: object
        geometry:
          $ref: '#/components/schemas/GeojsonGeometry'
        properties:
          properties:
            acquisitionDate:
              example: '2018-02-28T11:00:29.027Z'
              format: date-time
              type: string
            acquisitionStation:
              example: FR1
              type: string
            archivingCenter:
              example: FR1
              type: string
            azimuthAngle:
              example: 180.0016489732347
              format: double
              type: number
            cloudCover:
              example: 40.6133
              format: float
              type: number
            constellation:
              description: '*Enumeration is not restrictive*'
              enum:
              - SPOT
              - PLEIADES
              - SENTINEL-2
              example: PHR
              type: string
            correlationId:
              $ref: '#/components/schemas/Id'
            format:
              example: image/jp2
              type: string
            id:
              $ref: '#/components/schemas/Id'
            illuminationAzimuthAngle:
              example: 153.1708281261751
              format: double
              type: number
            illuminationElevationAngle:
              example: 41.29941056994953
              format: double
              type: number
            incidenceAngle:
              example: 18.92724363373624
              format: double
              type: number
            incidenceAngleAcrossTrack:
              example: 13.90087672831772
              format: double
              type: number
            incidenceAngleAlongTrack:
              example: 13.35195258346335
              format: double
              type: number
            organisationName:
              example: AIRBUS DS GEO
              type: string
            parentIdentifier:
              example: DS_PHR1A_201703101042018_FR1_PX_E002N41_0311_03240
              type: string
            platform:
              description: '*Enumeration is not restrictive*'
              enum:
              - PHR1A
              - SPOT6
              - SPOT7
              - SENTINEL2-A
              type: string
            processingCenter:
              example: FCMUGC
              type: string
            processingDate:
              example: '2017-11-22T10:54:33.987'
              format: date-time
              type: string
            processingLevel:
              example: SENSOR
              type: string
            processorName:
              example: IPU V_05_03vV_05_03
              type: string
            productType:
              description: '*Enumeration is not restrictive*'
              enum:
              - mono
              - bundle
              - panchromatic
              - multispectral
              - pansharpen
              type: string
            productionStatus:
              oneOf:
              - description: Internal item
                properties:
                  archive:
                    description: Data is archived outside the platform.
                    properties:
                      expirationDate:
                        description: >-
                          Date of deletion of this metadata item if no other
                          prodution status is defined.
                        example: '2019-03-31T10:59:16.537577277Z'
                        format: date-time
                        type: string
                    type: object
                  nearline:
                    description: Data is archived inside the platform.
                    properties:
                      expirationDate:
                        description: >-
                          Date of deletion of the data in the archive section
                          of the platform and deletion of the metadata item if
                          no other prodution status is defined.
                        example: '2019-03-31T10:59:16.537577277Z'
                        format: date-time
                        type: string
                    type: object
                  online:
                    description: Data is available on the platform.
                    properties:
                      expirationDate:
                        description: >-
                          Date of deletion of the data in the online section
                          of the platform and deletion of the metadata item if
                          no other prodution status is defined.
                        example: '2019-03-31T10:59:16.537577277Z'
                        format: date-time
                        type: string
                    type: object
                type: object
              - description: External item
                properties:
                  external:
                    description: Data is available outside the platform.
                    properties:
                      expirationDate:
                        description: Date of deletion of this metadata item
                        example: '2019-03-31T10:59:16.537577277Z'
                        format: date-time
                        type: string
                    type: object
                type: object
            publicationDate:
              example: '2018-03-31T10:59:16.537577277Z'
              format: date-time
              type: string
            qualified:
              example: false
              type: boolean
            resolution:
              description: In meters
              example: 0.5
              format: float
              type: number
            sensorType:
              example: OPTICAL
              type: string
            snowCover:
              example: 0
              format: float
              type: number
            sourceIdentifier:
              example: DS_PHR1A_201703101041248_FR1_PX_E002N41_0311_03233
              type: string
            spectralRange:
              example: VISIBLE
              type: string
            title:
              example: DS_PHR1A_201703101041248_FR1_PX_E002N41_0311_03233
              type: string
            workspaceId:
              $ref: '#/components/schemas/Id'
            workspaceName:
              example: public
              type: string
            workspaceTitle:
              example: Public
              type: string
          type: object
        rights:
          properties:
            associatedData:
              description: >-
                If present, indicates that the user who performed the request
                can use the associatedData links. Otherwise, a 403 status code
                will be returned.
              properties:
                privileges:
                  items:
                    $ref: '#/components/schemas/Privilege'
                  type: array
              type: object
            browse:
              description: >-
                If present, indicates that the user who performed the request
                can view the item in a catalog search response and can use the
                metadata and histogram links. Otherwise, a 403 status code will
                be returned.
              properties:
                privileges:
                  items:
                    $ref: '#/components/schemas/Privilege'
                  type: array
              type: object
            buffer:
              description: >-
                If present, indicates that the user who performed the request
                can use the buffer links. Otherwise, a 403 status code will be
                returned.
              properties:
                privileges:
                  items:
                    $ref: '#/components/schemas/Privilege'
                  type: array
              type: object
            download:
              description: >-
                If present, indicates that the user who performed the request
                can use the download link. Otherwise, a 4

# --- truncated at 32 KB (563 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/airbus-oneatlas/refs/heads/main/openapi/oneatlas-data-pay-per-order-api-openapi.yml