prosEO Product Archive Manager REST Services API API documentation version v0.1

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: RestProductArchive

Example:

[
    {
        "code": "MY_PRIP",
        "name": "My Production Service Interface Delivery Point",
        "archiveType": "PRIP",
        "baseUri": "https://prip.proseo-domain.de:8443",
        "context": "proseo/prip/odata/v1",
        "tokenRequired": false,
        "username": "PTM\\proseo",
        "password": "mypwd",
        "availableProductClasses": [ "PTM_L1B", "PTM_L2A", "PTM_L2B", "PTM_L3" ]
    },
    {
        "code": "MY_LTA",
        "name": "My Long Term Archive",
        "archiveType": "AIP",
        "baseUri": "https://archive.proseo-domain.de:8443",
        "context": "proseo/aip/odata/v1",
        "tokenRequired": true,
        "tokenUri": "https://idprovided.proseo-domain.de/proseo/token",
        "username": "PTM\\proseo",
        "password": "mypwd",
        "availableProductClasses": [ "PTM_L1B", "PTM_L2A", "PTM_L2B", "PTM_L3" ]
    }
]

HTTP status code 400

The request sent to the server contains data which is not as expected e.g. invalid location URI

Headers

• Warning: required(string - pattern: ^\d{3} proseo-facmgr \(.\d+\) .+$)

  An error code and a plain text error message

  Example:

  199 proseo-facmgr (E1005) Facility ID not set

HTTP status code 404

The requested resource was not found

Headers

• Warning: required(string - pattern: ^\d{3} proseo-facmgr \(.\d+\) .+$)

  An error code and a plain text error message

  Example:

  199 proseo-facmgr (E1005) Facility ID not set

HTTP status code 201

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• code: required(string)

  Short code for the archive (unique key)

• name: required(string)

  Descriptive name for the archive

• archiveType: required(string - default: AIP - pattern: ^(AIP|AUXIP|PODIP|PRIP|SIMPLEAIP)$)

  Interface protocol for this archive, one of { AIP, AUXIP, PODIP, PRIP, SIMPLEAIP }

• baseUri: required(string)

  Base URI to access the archive (of the form "http[s]://<hostname>[:<port>]", no trailing slash)

• context: required(string)

  The context path of the archive service endpoint

• tokenRequired: required(boolean)

  Flag indicating whether token-based authentication shall be used

• tokenUri: (string)

  The full URI for token requests (may be routed to a different host from the archive service itself)

• username: (string)

  The username for Basic Authentication (for token or service requests, depending on authentication method)

• password: (string)

  Password for Basic Authentication (CAUTION - Clear text)

• clientId: (string)

  Client-ID for OpenID-based token requests

• clientSecret: (string)

  Client secret for OpenID-based token requests

• sendAuthInBody: (boolean - default: false)

  Flag indicating whether credentials for OpenID-based token requests shall be sent in request body

• availableProductClasses: required(array of string)

  List of product class names (product types) retrievable from this archive

Example:

{
    "code": "MY_PRIP",
    "name": "My Production Service Interface Delivery Point",
    "archiveType": "PRIP",
    "baseUri": "https://prip.proseo-domain.de:8443",
    "context": "proseo/prip/odata/v1",
    "tokenRequired": false,
    "username": "PTM\\proseo",
    "password": "mypwd",
    "availableProductClasses": [ "PTM_L1B", "PTM_L2A", "PTM_L2B", "PTM_L3" ]
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• code: required(string)

  Short code for the archive (unique key)

• name: required(string)

  Descriptive name for the archive

• archiveType: required(string - default: AIP - pattern: ^(AIP|AUXIP|PODIP|PRIP|SIMPLEAIP)$)

  Interface protocol for this archive, one of { AIP, AUXIP, PODIP, PRIP, SIMPLEAIP }

• baseUri: required(string)

  Base URI to access the archive (of the form "http[s]://<hostname>[:<port>]", no trailing slash)

• context: required(string)

  The context path of the archive service endpoint

• tokenRequired: required(boolean)

  Flag indicating whether token-based authentication shall be used

• tokenUri: (string)

  The full URI for token requests (may be routed to a different host from the archive service itself)

• username: (string)

  The username for Basic Authentication (for token or service requests, depending on authentication method)

• password: (string)

  Password for Basic Authentication (CAUTION - Clear text)

• clientId: (string)

  Client-ID for OpenID-based token requests

• clientSecret: (string)

  Client secret for OpenID-based token requests

• sendAuthInBody: (boolean - default: false)

  Flag indicating whether credentials for OpenID-based token requests shall be sent in request body

• availableProductClasses: required(array of string)

  List of product class names (product types) retrievable from this archive

Example:

{
    "code": "MY_PRIP",
    "name": "My Production Service Interface Delivery Point",
    "archiveType": "PRIP",
    "baseUri": "https://prip.proseo-domain.de:8443",
    "context": "proseo/prip/odata/v1",
    "tokenRequired": false,
    "username": "PTM\\proseo",
    "password": "mypwd",
    "availableProductClasses": [ "PTM_L1B", "PTM_L2A", "PTM_L2B", "PTM_L3" ]
}

HTTP status code 200

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• code: required(string)

  Short code for the archive (unique key)

• name: required(string)

  Descriptive name for the archive

• archiveType: required(string - default: AIP - pattern: ^(AIP|AUXIP|PODIP|PRIP|SIMPLEAIP)$)

  Interface protocol for this archive, one of { AIP, AUXIP, PODIP, PRIP, SIMPLEAIP }

• baseUri: required(string)

  Base URI to access the archive (of the form "http[s]://<hostname>[:<port>]", no trailing slash)

• context: required(string)

  The context path of the archive service endpoint

• tokenRequired: required(boolean)

  Flag indicating whether token-based authentication shall be used

• tokenUri: (string)

  The full URI for token requests (may be routed to a different host from the archive service itself)

• username: (string)

  The username for Basic Authentication (for token or service requests, depending on authentication method)

• password: (string)

  Password for Basic Authentication (CAUTION - Clear text)

• clientId: (string)

  Client-ID for OpenID-based token requests

• clientSecret: (string)

  Client secret for OpenID-based token requests

• sendAuthInBody: (boolean - default: false)

  Flag indicating whether credentials for OpenID-based token requests shall be sent in request body

• availableProductClasses: required(array of string)

  List of product class names (product types) retrievable from this archive

Example:

{
    "code": "MY_PRIP",
    "name": "My Production Service Interface Delivery Point",
    "archiveType": "PRIP",
    "baseUri": "https://prip.proseo-domain.de:8443",
    "context": "proseo/prip/odata/v1",
    "tokenRequired": false,
    "username": "PTM\\proseo",
    "password": "mypwd",
    "availableProductClasses": [ "PTM_L1B", "PTM_L2A", "PTM_L2B", "PTM_L3" ]
}

HTTP status code 304

Body

Media type: application/json

Type: object

• id: (integer - default: 0)

  The persistent id of this object

• version: (integer - default: 1)

  A version identifier to track updates to the object (especially to detect concurrent update attempts)

• code: required(string)

  Short code for the archive (unique key)

• name: required(string)

  Descriptive name for the archive

• archiveType: required(string - default: AIP - pattern: ^(AIP|AUXIP|PODIP|PRIP|SIMPLEAIP)$)

  Interface protocol for this archive, one of { AIP, AUXIP, PODIP, PRIP, SIMPLEAIP }

• baseUri: required(string)

  Base URI to access the archive (of the form "http[s]://<hostname>[:<port>]", no trailing slash)

• context: required(string)

  The context path of the archive service endpoint

• tokenRequired: required(boolean)

  Flag indicating whether token-based authentication shall be used

• tokenUri: (string)

  The full URI for token requests (may be routed to a different host from the archive service itself)

• username: (string)

  The username for Basic Authentication (for token or service requests, depending on authentication method)

• password: (string)

  Password for Basic Authentication (CAUTION - Clear text)

• clientId: (string)

  Client-ID for OpenID-based token requests

• clientSecret: (string)

  Client secret for OpenID-based token requests

• sendAuthInBody: (boolean - default: false)

  Flag indicating whether credentials for OpenID-based token requests shall be sent in request body

• availableProductClasses: required(array of string)

  List of product class names (product types) retrievable from this archive

Example:

{
    "code": "MY_PRIP",
    "name": "My Production Service Interface Delivery Point",
    "archiveType": "PRIP",
    "baseUri": "https://prip.proseo-domain.de:8443",
    "context": "proseo/prip/odata/v1",
    "tokenRequired": false,
    "username": "PTM\\proseo",
    "password": "mypwd",
    "availableProductClasses": [ "PTM_L1B", "PTM_L2A", "PTM_L2B", "PTM_L3" ]
}

HTTP status code 204