<access-service>/api/v1/plans

URL structure

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

Supported methods and overview

• POST - used to add a new plan.
• GET - used to retrieve a list of field information for all current plans on the Covata Platform.

Note: The GET method takes no parameters.

Detailed description

This API endpoint serves a number of purposes:

• Adds a new plan to the Covata Platform.
• Retrieves a list of field information for all current plans on the Covata Platform.

Supported roles

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

• System 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

The following header is required if the body of the request has a JSON object:

• Content-Type: application/json

Required parameters

The following required parameters must be sent in the body of the POST request, as individual members of a JSON object:

• description - .
• name - .

• quota - Specify in MB.

  Example ():

Optional parameters

The following optional parameter can also be sent in the body of the POST request, as individual members of the JSON object that includes the Required parameters above:

• default - true or false.

  Example ():

Returns

A JSON-formatted response containing the following members:

• items - .
  • id - .
  • name - .
  • default - .
  Example (response from ...):