GET /api/apis

Returns information about APIs on the platform. With the optional query parameter, returns information about the APIs associated with the specified business organization.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis[?BusinessID={BusinessID}]

Back to top

Sample Request

The example below uses the optional BusinessID query parameter to request information about APIs associated with the specified business.

Request URL

https://{hostname}/api/apis?BusinessID=c8d4e833-3569-418c-b0e0-ad222be1feef.acmepaymentscorp

Sample request headers

Accept: application/vnd.soa.v83+json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept application/vnd.soa.v83+json or application/vnd.soa.v83+xml
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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
BusinessID Query string Optional

The unique ID for a specific business organization on the platform.

If this parameter is included, only APIs relating to the specified business organization are returned, and the AvatarURL is included if it exists.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the APIs on the platform.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/vnd.soa.v83+json

Status Code: 200 OK
Content-Type: application/vnd.soa.v83+json
Date: Fri, 02 Sep 2016 15:42:25 GMT

Sample response body: application/vnd.soa.v83+json

The example below is in response to a request that does not include the optional query parameter.

{
  "APIInfo" : [ {
    "APIID" : "58596ace-0d7d-4c34-88b1-75530edb8dcb.acmepaymentscorp",
    "Name" : "Crest",
    "Created" : "2016-09-02T15:31:08Z",
    "Updated" : "2016-09-02T15:31:08Z",
    "State" : "com.soa.api.state.active",
    "Visibility" : "Public"
  }, {
    "APIID" : "5f357880-6e42-47f8-b711-e80ce21807de.acmepaymentscorp",
    "Name" : "Billing API",
    "Description" : "Billing API",
    "Created" : "2016-09-02T15:31:35Z",
    "Updated" : "2016-09-02T15:31:35Z",
    "State" : "com.soa.api.state.active",
    "Visibility" : "Public"
  }, {
    "APIID" : "826e71c2-62f8-45b8-aa3f-8df040809358.acmepaymentscorp",
    "Name" : "Payments API",
    "Description" : "Payments API",
    "Created" : "2016-09-02T15:31:55Z",
    "Updated" : "2016-09-02T15:31:55Z",
    "State" : "com.soa.api.state.active",
    "Visibility" : "Public"
  } ]
}

Back to top

Sample response headers: application/vnd.soa.v83+xml

Status Code: 200 OK
Content-Type: application/vnd.soa.v83+xml
Date: Fri, 02 Sep 2016 15:39:51 GMT

Sample response body: application/vnd.soa.v83+xml

The example below is in response to a request that included the optional BusinessID parameter. AvatarURL for the type of business is included in the results.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns7:APIInfos xmlns:ns2="http://soa.com/xsd/business/1.0" xmlns:ns3="http://soa.com/xsd/resource/1.0" 
xmlns:ns4="http://soa.com/xsd/deploymentzone/1.0" xmlns:ns5="http://soa.com/xsd/asset/1.0" 
xmlns:ns6="http://soa.com/xsd/dnmodel/1.0" xmlns:ns7="http://soa.com/xsd/api/1.0" 
xmlns:ns8="http://soa.com/xsd/legals/1.0">
  <ns7:APIInfo>
    <ns7:APIID>58596ace-0d7d-4c34-88b1-75530edb8dcb.acmepaymentscorp</ns7:APIID>
    <ns7:Name>Crest</ns7:Name>
    <ns7:Created>2016-09-02T15:31:08Z</ns7:Created>
    <ns7:Updated>2016-09-02T15:31:08Z</ns7:Updated>
    <ns7:State>com.soa.api.state.active</ns7:State>
    <ns7:Visibility>Public</ns7:Visibility>
    <ns7:AvatarURL>{hostname}/api/apis/avatar/_Vw_9pYswpnTtKGnzr4ZmUow</ns7:AvatarURL>
  </ns7:APIInfo>
  <ns7:APIInfo>
    <ns7:APIID>5f357880-6e42-47f8-b711-e80ce21807de.acmepaymentscorp</ns7:APIID>
    <ns7:Name>Billing API</ns7:Name>
    <ns7:Description>Billing API</ns7:Description>
    <ns7:Created>2016-09-02T15:31:35Z</ns7:Created>
    <ns7:Updated>2016-09-02T15:31:35Z</ns7:Updated>
    <ns7:State>com.soa.api.state.active</ns7:State>
    <ns7:Visibility>Public</ns7:Visibility>
    <ns7:AvatarURL>{hostname}/api/apis/avatar/_Vw_9pYswpnTtKGnzr4ZmUow</ns7:AvatarURL>
  </ns7:APIInfo>
</ns7:APIInfos>

Back to top

Response Headers

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

Header Description
Content-Type application/vnd.soa.v83+json or application/vnd.soa.v83+xml

Back to top

Response Body

Name Type Description
APIInfos APIInfos Contains information about one or more APIs that were defined using a Swagger 2.0 description document.

Back to top

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.

Back to top

Related Topics