GET /api/apis/versions/{APIVersionID}/design
Returns information about the API design for the specified API version, in the form of a Swagger document.
Authorization Roles/Permissions: Must have Read permission for the resource.
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/apis/versions/{APIVersionID}/design
Sample Request
The example below shows a request for the Swagger API description document for the specified API.
Request URL
https://{hostname}/api/apis/versions/f0e489e7-e647-4eb2-9efd-0044f2d4b650.acmepaymentscorp/design
Sample request headers
Accept: application/octet-stream
Sample request body
Not applicable.
Request Headers
For general information on request header values, refer to HTTP Request Headers.
| Header | Description |
|---|---|
| Accept | application/octet-stream or other media type depending on the API design. |
| 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 |
|---|---|---|---|---|
| APIVersionID | Path | string | Required | The unique ID for a specific API version. |
| specification | Query | string | Optional | The API specification document. |
Response
If successful, this operation returns HTTP status code 200, with information about the API design.
Sample Response
The sample response below shows successful completion of this operation.
Sample response headers: application/octet-stream
Status Code: 200 OK Content-Type: application/octet-stream Date: Tue, 01 Mar 2016 20:41:54 GMT
Sample response body: application/octet-stream
{
"swagger":"2.0",
"info":{
"title":"Aria_Object_Query_API0",
"version":"v1"
},
"tags":[
{
"name":"Aria_Object_Query_API0"
}
],
"paths":{
"/":{
"post":{
"tags":[
"Aria_Object_Query_API0"
],
"description":"Query Aria",
"operationId":"POST__",
"consumes":[
"text/plain"
],
"produces":[
"application/json"
],
"parameters":[
{
"in":"body",
"name":"body",
"required":false
}
],
"responses":{
"200":{
"description":""
}
},
"deprecated":false
}
}
}
}
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | The content-type is determined by the API version design. |
Response Body
| Name | Type | Description |
|---|---|---|
| API | API | Contains information about an API. |
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.
