Error Messages Returned by the Contract Workspace Management APIs

The APIs within the Contract Workspace Management APIs returns response codes when you submit a request. The following table describes the response codes:

HTTP response code

Message

Description

400

The API key passed in the request is not valid.

The API key passed in the query headers does not match the API key in the OAuth token.

Bad Request

The request was unsuccessful because of one of the following reasons:

  • The required feature is not enabled.

  • This is not applicable to the POST /contractworkspaces endpoint.

  • One or more parameters specified in the request are incorrect.

  • A baseline contract cannot be created without linking a predecessor project to it. Please provide the predecessor project ID in the eventInternalId field and try again.

  • The following fields cannot be updated : [supplier]

  • Updating the predecessor project of a baseline contract is not allowed. Please remove the field eventInternalId from the request body and try again.

  • Action 'amend' is currently not supported.

  • The request was unsuccessful because the parent agreement specified for the subagreement contract does not have a valid hierarchical type.

401

Unauthorized

The request was unsuccessful because of one of the following reasons:

  • Invalid expression.

  • The OAuth token has expired or is invalid. A new OAuth token needs to be generated.

  • The feature is not enabled.

403

Forbidden

The request was unsuccessful because of one of the following reasons:

  • Contract data is missing in the request.

  • You do not have permission to access the requested resource.

404

Not Found

The request was unsuccessful because of one of the following reasons:

  • Request has one or more invalid contracts.

  • Your query requests a resource that is not in the system.

429

Rate limit error

You have exceeded the maximum permitted query rate. Refer to the developer portal discovery page for this API for the applicable query rates.

504

Gateway Time-out

The server timeout time has been exceeded, possibly due to network traffic or reliability issues. Retry your query.