GET /api/users/{UserID}/apis
Returns a list of APIs for the specified user. Includes information about the APIs that the specified user is connected to; for example, as an API Administrator, API Scope Group member, or as an app team member for an app that's subscribed to the API.
Note: GET /api/users/{UserID}/apis (list apps, with custom Accept header) returns the same information as a JSON object. We recommend using that operation rather than this one.
Authorization Roles/Permissions: Must be logged in. Self (logged in) or Site Admin (for any user).
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/users/{UserID}/apis[?includeVersions=boolean][&start=int]
[&count=int][&VersionCount=int]
Sample Request
The example below shows a request for information about the APIs that the specified user is associated with.
Sample Request URL
https://{hostname}/api/users/092fa149-78e1-4638-9fef-ec10411e3d33.acmepaymentscorp/apis
Sample request headers
Accept: application/json 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/rss+xml 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 |
|---|---|---|---|---|
| UserID | Path | string | Required | The unique ID for a specific user. |
| versionCount | Query | integer | Optional | Indicates the number of versions to be included in the results. If not specified, defaults to 0, so versions are not included. |
Response
If successful, this operation returns HTTP status code 200, with information about the APIs for the specified user in the form of an RSS channel.
Sample Response
The sample response below shows successful completion of this operation. The specified user has four APIs.
Sample response headers: application/json
Status Code: 200 OK Content-Type: application/json Date: Tue, 28 Jul 2020 15:49:14 GMT
Sample response body: application/json
{
"channel":{
"title":"My Apis",
"link":"../../atmosphere#/user/092fa149-78e1-4638-9fef-ec10411e3d33.acmepaymentscorp/apis",
"description":"List of apis by user",
"item":[
{
"title":"httpbin",
"category":[
{
"value":"api",
"domain":"uddi:soa.com:resourcetype"
},
{
"value":"Public",
"domain":"uddi:soa.com:visibility"
},
{
"value":"true",
"domain":"uddi:soa.com:in-user-top"
}
],
"guid":{
"value":"264aafe9-40f9-495d-b31f-c45332bad273.acmepaymentscorp"
},
"pubDate":"Tue, 28 Jul 2020 15:43:25 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"httpbin (1)",
"Guid":"437d5621-2667-4142-9cfe-48fb883b8ce9.acmepaymentscorp",
"Category":[
{
"value":"apiversion",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
},
"Connections":0,
"Rating":0.0,
"EntityReference":{
"Title":"httpbin (1)",
"Guid":"437d5621-2667-4142-9cfe-48fb883b8ce9.acmepaymentscorp",
"Category":[
{
"value":"apiversion",
"domain":"uddi:soa.com:resourcetype"
}
]
},
"Image":{
"Url":"http://api.acmepaymentscorp.com/api/apis/avatar/_VO1w_o3OUc8XvDF1ng7dfGg"
},
"Followers":0
},
{
"title":"Swagger_Petstore_5_Operations",
"category":[
{
"value":"api",
"domain":"uddi:soa.com:resourcetype"
},
{
"value":"Public",
"domain":"uddi:soa.com:visibility"
},
{
"value":"true",
"domain":"uddi:soa.com:in-user-top"
}
],
"guid":{
"value":"5b6965d8-cf41-4da4-82cd-b76434d7ec6a.acmepaymentscorp"
},
"pubDate":"Tue, 28 Jul 2020 15:43:56 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"Swagger_Petstore_5_Operations (v1)",
"Guid":"d5fbbe63-1f7d-498e-a4a1-41a6a3a219e5.acmepaymentscorp",
"Category":[
{
"value":"apiversion",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
},
"Connections":0,
"Rating":0.0,
"EntityReference":{
"Title":"Swagger_Petstore_5_Operations (v1)",
"Guid":"d5fbbe63-1f7d-498e-a4a1-41a6a3a219e5.acmepaymentscorp",
"Category":[
{
"value":"apiversion",
"domain":"uddi:soa.com:resourcetype"
}
]
},
"Image":{
"Url":"http://api.acmepaymentscorp.com/api/apis/avatar/_VO1w_o3OUc8XvDF1ng7dfGg"
},
"Followers":0
}
]
},
"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/rss+xml 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
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 My Apis, and the channel includes a link to the source of the RSS channel information and a text description of the RSS channel. Each item in the RSS channel represents an API for which the specified user is an administrator, and includes the information below.
| Name | Description |
|---|---|
| title | The text title of the API. |
| description | Text description of the API. |
| category[ ] |
An array of sets of name/value pairs, each including Value and Domain, with a value for each. For example: "value" : "api", "domain" : "uddi:soa.com:resourcetype" The example above indicates a resource type of api. "value":"true", "domain":"uddi:soa.com:in-user-top The example above indicates that the API is in the user's top APIs, on the users's My Dashboard feature. |
| GUID | GUID for the API; the APIID. |
| pubdate | The date/timestamp when the API was created. |
| rating | The overall rating for the API. |
| followers | The number of users following the API. |
| image | URL to the API's avatar, if applicable. If the API has no custom avatar, the URL to the default API avatar is included. |
| Entity reference |
An array of one or more entity references for the API, with information about the API versions. Each includes:
|
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. |
| 404 | The resource could not be found. For example, you might get this if you include an invalid request parameter value. |
| 500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.