<access-service>/api/v1

URL structure

https://access-service.xy-company.com/api/v1

Supported methods and overview

• GET - used to retrieve a list of callable API endpoints on the Covata Platform's Access Service, which are available to integrators.

Note: This method takes no parameters.

Detailed description

Note: The content in this section of the page (and after Required Headers below) is incomplete and will be completed in due course.

Supported roles

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator's Guide):

• Originator
• Collaborator
• System administrator
• User administrator

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6

Returns

A JSON-formatted response containing the following members:

• contentServiceURL - .

• services - An array containing information about each callable API endpoint on the Covata Platform's Access Service. Each element of this array contains information about one of these endpoints and is represented as an object, containing the following members:

  • name - .
  • link - .
  • httpMethod - .

  Example: