GET /api/apis/versions
Returns information about API versions for all APIs, in the form of an RSS channel.
Version information does not include operations. For information about operations for a specific API version, use GET /api/apis/versions/{APIVersionID} with the optional includeOperations parameter.
GET /api/apis/versions (this operation) with text/xml or application/json content-type returns API version information in the form of an RSS channel; GET /api/apis/versions returns it as a JSON or XML object. Both operations return the same information; only the structure/format is different.
Note: this operation might return a large amount of content. If you want to view versions for a specific API, use the GET apis/{APIID}/versions operation instead.
Authorization Roles/Permissions: Must be logged in. Must be authorized to view all APIs on the Community Manager developer portal: Business Admin.
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/apis/versions
Sample Request
The first example below shows a request for all available versions. The second example shows a request for versions that are currently in an Open state.
Request URL #1
https://{hostname}/api/apis/versions
Request URL #2
https://{hostname}/api/apis/versions?state=com.soa.api.state.open
Sample request headers
GET /api/apis/versions HTTP/1.1 Accept: application/json, text/xml 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, text/xml application/vnd.soa.v71+json, application/vnd.soa.v71+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 |
|---|---|---|---|---|
| State | Query | string | Optional |
If a state is specified, only APIs in that state are returned. For valid values, see API States. If this parameter is not specified, all matching results are returned. |
| IncludeEndpoints | Query | Boolean | Optional | Indicates whether information about endpoints should be included in the response. Default: true. |
| IncludeTags | Query | Boolean | Optional | Indicates whether information about tags should be included in the response. Default: false. |
Response
If successful, this operation returns HTTP status code 200, with a list of all the API versions visible to the user initiating the operation. The information is sent as an RSS channel in JSON or XML format.
Sample Response
The sample response below shows a total of four versions.
Sample response headers: application/json
Status Code: 200 OK Content-Type: application/json
Sample response body: application/json
{
"channel": {
"title": "API Versions",
"item": [
{
"title": "1.1",
"description": "Update to first release includes key fixes.",
"category": [
{
"value": "apiversion",
"domain": "uddi:soa.com:resourcetype"
},
{
"value": "com.soa.api.state.open",
"domain": "uddi:soa.com:state"
},
{
"value": "Public",
"domain": "uddi:soa.com:visibility"
},
{
"value": "payments API",
"domain": "uddi:soa.com:tag"
}
],
"guid": {
"value": "apiversion18972.acmepaymentscorp"
},
"pubDate": "Fri, 18 Jan 2013 09:10:50 GMT",
"Endpoints": {
"Endpoint": [
{
"Category": "Sandbox",
"Uri": "http://acmepaymentscorpsandbox.broker.soa.com/payments"
},
{
"Category": "Production",
"Uri": "http://acmepaymentscorp.broker.soa.com/payments"
}
]
},
"EntityReferences": {
"EntityReference": [
{
"Title": "acmepaymentscorp",
"Guid": "api18969.acmepaymentscorp",
"Category": [
{
"value": "api",
"domain": "uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title": "1.0",
"description": "First release.",
"category": [
{
"value": "apiversion",
"domain": "uddi:soa.com:resourcetype"
},
{
"value": "com.soa.api.state.open",
"domain": "uddi:soa.com:state"
},
{
"value": "Public",
"domain": "uddi:soa.com:visibility"
},
{
"value": "payments API",
"domain": "uddi:soa.com:tag"
}
],
"guid": {
"value": "apiversion18971.acmepaymentscorp"
},
"pubDate": "Fri, 18 Jan 2013 08:46:27 GMT",
"Endpoints": {
"Endpoint": [
{
"Category": "Sandbox",
"Uri": "http://acmepaymentscorpsandbox.broker.soa.com/payments"
},
{
"Category": "Production",
"Uri": "http://acmepaymentscorp.broker.soa.com/payments"
}
]
},
"EntityReferences": {
"EntityReference": [
{
"Title": "acmepaymentscorp",
"Guid": "api18969.acmepaymentscorp",
"Category": [
{
"value": "api",
"domain": "uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title": "1.0",
"description": "",
"category": [
{
"value": "apiversion",
"domain": "uddi:soa.com:resourcetype"
},
{
"value": "com.soa.api.state.deleted",
"domain": "uddi:soa.com:state"
},
{
"value": "Public",
"domain": "uddi:soa.com:visibility"
}
],
"guid": {
"value": "apiversion401.acmepaymentscorp"
},
"pubDate": "Wed, 13 Jun 2012 06:31:01 GMT",
"Endpoints": {
"Endpoint": [
{
"Category": "Sandbox",
"Uri": "http://broker.soa.com:9906/content"
},
{
"Category": "Production",
"Uri": "http://broker.soa.com:9906/content"
}
]
},
"EntityReferences": {
"EntityReference": [
{
"Title": "ACMECorp Content Management API",
"Guid": "api101.acmepaymentscorp",
"Category": [
{
"value": "api",
"domain": "uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title": "v1",
"description": "v1",
"category": [
{
"value": "apiversion",
"domain": "uddi:soa.com:resourcetype"
},
{
"value": "com.soa.api.state.open",
"domain": "uddi:soa.com:state"
},
{
"value": "Public",
"domain": "uddi:soa.com:visibility"
},
{
"value": "weather",
"domain": "uddi:soa.com:tag"
},
{
"value": "Yahoo",
"domain": "uddi:soa.com:tag"
},
{
"value": "Yahoo Weather",
"domain": "uddi:soa.com:tag"
},
{
"value": "YahooWeather",
"domain": "uddi:soa.com:tag"
}
],
"guid": {
"value": "apiversion13558.acmepaymentscorp"
},
"pubDate": "Fri, 11 Jan 2013 07:13:29 GMT",
"Endpoints": {
"Endpoint": [
{
"Category": "Production",
"Uri": "http://yw.broker.soa.com/1"
}
]
},
"EntityReferences": {
"EntityReference": [
{
"Title": "Yahoo Weather",
"Guid": "api13556.acmepaymentscorp",
"Category": [
{
"value": "api",
"domain": "uddi:soa.com:resourcetype"
}
]
}
]
}
}
]
},
"version": "1.0"
}
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type |
application/json, text/xml application/vnd.soa.v71+json, application/vnd.soa.v71+xml |
Response Body
The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The title of the RSS channel is List API Versions. Each API version includes the information listed below.
| Name | Description |
|---|---|
| title | The title of the API version. |
| description | The text description of the API version. |
| category |
An array of name/value pair sets containing information about values associated with the API version. Each includes Value and Domain. Domain indicates the type of value, Value indicates the actual value. For example: "value": "Public", "domain": "uddi:soa.com:visibility" The above indicates that the visibility setting for the API version is public. |
| guid | The value for this parameter is the APIVersionID. |
| pubDate | The publication date for the API version, formatted in Coordinated Universal Time (UTC). |
| Endpoints |
An array of name/value pair sets containing information about the endpoints for the API version. Each includes Category, which is either Sandbox or Production, and URI, which is the URI for the endpoint. For example: "Category": "Sandbox", "Uri": "http://acmepaymentscorpsandbox.broker.soa.com/payments" The above indicates that the specified URI is for the Sandbox implementation. |
| EntityReferences |
Contains information about the API to which each listed API version belongs, including:
|
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.