GET /api/contracts/{ContractID}

Retrieves information about the specified contract.

Note: To get a list of contracts for a specific app or API you can use GET /api/apps/versions/{AppVersionID}/contracts or GET /api/apis/versions/{APIVersionID}/contracts. This operation returns a specific contract. If you have the ContractID, you can use this operation to get information about the contract.

Authorization Roles/Permissions: Must be logged in. To complete this operation successfully, a user must be a member of the applicable team (App team member or API Admin) or a Site Admin.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/contracts/{ContractID}

Sample Request

The example below shows a request for information about the specified contract.

Sample Request URL

https://{hostname}/api/contracts/e31f8041-ff77-4153-8d4b-4a86795b2865.acmepaymentscorp

Sample request headers

GET /api/contracts/e31f8041-ff77-4153-8d4b-4a86795b2865.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: application/json
AtmoAuthToken_acmepaymentscorp=TokenID%3Dcd36a4bd-e600-4e99-961a-c4ca0cfc93cd%2Cclaimed_id%3Durn%3Aatmosphere%3Auser%3Aacmepaymentscorp%3A14b1902f-3dfc-43e3-b09a-81137f091b96%2CissueTime%3D1614802132363%2CexpirationTime%3D1614803992357%2C...
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json application/vnd.soa.v71+json, application/vnd.soa.v71+xml application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
ContractID	Path	string	Required	The unique ID for a specific contract between an app version and an API version.

Response

If successful, this operation returns HTTP status code 200, with the contract information in the requested format.

Sample Response

The sample response below shows information about the specified contract.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Wed, 04 Sep 2019 18:20:20 GMT

Sample response body #1: application/json

In this example, there are no policies assigned to the contract.

{
  "ContractID": "e31f8041-ff77-4153-8d4b-4a86795b2865.acmepaymentscorp",
  "APIVersionID": "9daf2b49-0b00-45c2-8ccf-db5ef3d478af.acmepaymentscorp",
  "RuntimeID": "wbN3rqWphd4z6LtgwI5oMRbrZoYrwQ4OvKrBn19o.acmepaymentscorp",
  "Environment": "Production",
  "State": "apicontract.status.activated",
  "ContractScope": {
    "Restricted": false
  },
  "Updated": "2019-09-04T18:07:32Z",
  "UpdatedInMillis": 1567620452000,
  "Status": "com.soa.apicontract.inforce"
}

Sample response body #2: application/json

In this example, there is a policy assigned to the contract. The contract has not yet been activated.

{
  "ContractID": "66176dea-874b-439b-9f3b-104ac0595245.acmepaymentscorp",
  "APIVersionID": "9daf2b49-0b00-45c2-8ccf-db5ef3d478af.acmepaymentscorp",
  "RuntimeID": "ZkJqWIs4TWzU9sWla7tsrJUdJr38xTKwMXxffV95.acmepaymentscorp",
  "Environment": "Production",
  "Policies": {
    "Policy": [
      {
        "PolicyKey": "uddi:34d9e157-c73c-4d86-a1e6-d9d07e994cba",
        "Name": "Bandwidth Quota QOS Policy",
        "Description": "Bandwidth Quota",
        "PolicyType": "Service Level Policy",
        "PolicySubType": "policy.qos.bandwidthquota"
      }
    ]
  },
  "State": "apicontract.status.approved",
  "ContractScope": {
    "Restricted": false
  },
  "Updated": "2019-09-06T21:13:10Z",
  "UpdatedInMillis": 1567804390000,
  "Status": "com.soa.apicontract.draft"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json application/vnd.soa.v71+json, application/vnd.soa.v71+xml application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Response Body

Name	Type	Description
Contract	Contract	Information about the contract.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics