GET /api/apis

Returns a list of all APIs on the platform. With an optional parameter, lists APIs owned by a specific 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}][&Federation={Federation}]

Back to top

Sample Request

The example below shows a request without the optional parameters.

Request URL

https://{hostname}/api/apis

Sample request headers

GET /api/apis HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
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/json, text/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

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 organization are returned.

Federation Query boolean Optional

Indicates whether the current implementation is a federation.

If not specified, defaults to true.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the list of APIs. The information is sent as an RSS channel in JSON or XML format.

Back to top

Sample Response

The sample response below shows the results of a request without the optional parameters, when there are three APIs on the platform. Both JSON and XML examples are provided.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Thu, 20 Sep 2012 00:30:21 GMT
Content-Type: application/json

Sample response body: application/json

{
  "channel" : {
    "title" : "APIs",
    "item" : [ {
      "title" : "ACMECorp Content Management API",
      "description" : "",
      "category" : [ {
        "value" : "api",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      } ],
      "guid" : {
        "value" : "api101.acmepaymentscorp"
      },
      "pubDate" : "Tue, 18 Sep 2012 21:40:27 PDT",
      "EntityReference" : {
        "Title" : "ACMECorp Content Management API (1.0)",
        "Guid" : "apiversion401.acmepaymentscorp",
        "Category" : [ {
          "value" : "apiversion",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }
    }, {
      "title" : "ACMECorp OpenID API",
      "description" : "OpenID Service",
      "category" : [ {
        "value" : "api",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      } ],
      "guid" : {
        "value" : "api102.acmepaymentscorp"
      },
      "pubDate" : "Tue, 18 Sep 2012 21:40:27 PDT",
      "EntityReference" : {
        "Title" : "ACMECorp OpenID API (1.0)",
        "Guid" : "apiversion402.acmepaymentscorp",
        "Category" : [ {
          "value" : "apiversion",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }
    }, {
      "title" : "Movies",
      "description" : "Interfaces with a movie database for add, modify, delete, and read of movie information.",
      "category" : [ {
        "value" : "api",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      } ],
      "guid" : {
        "value" : "api10041.acmepaymentscorp"
      },
      "pubDate" : "Wed, 19 Sep 2012 13:51:12 PDT",
      "EntityReference" : {
        "Title" : "Movies (1.0)",
        "Guid" : "apiversion10043.acmepaymentscorp",
        "Category" : [ {
          "value" : "apiversion",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }
    } ]
  },
  "version" : "1.0"
}

Back to top

Sample response headers: text/xml

Status Code: 200 OK
Date: Thu, 20 Sep 2012 00:30:21 GMT
Content-Type: text/xml

Sample response body: text/xml

<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:ns2="http://soa.com/xsd/rss/1.0" xmlns:ns3="http://soa.com/xsd/comment/1.0" xmlns:ns4="http://soa.com/xsd/user/
1.0" xmlns:ns5="http://a9.com/-/spec/opensearch/1.1/" xmlns:ns6="http://soa.com/xsd/resource/1.0" xmlns:ns7="http://soa.com/
xsd/fault/1.0" xmlns:ns8="http://soa.com/xsd/api/1.0" version="1.0">
  <channel>
    <title>APIs</title>
    <item>
      <title>ACMECorp Content Management API</title>
      <description></description>
      <category domain="uddi:soa.com:resourcetype">api</category>
      <category domain="uddi:soa.com:visibility">Public</category>
      <guid>api101.acmepaymentscorp</guid>
      <pubDate>Tue, 18 Sep 2012 21:40:27 PDT</pubDate>
      <ns2:EntityReference>
        <Title>ACMECorp Content Management API (1.0)</Title>
        <Guid>apiversion401.acmepaymentscorp</Guid>
        <ns2:Category domain="uddi:soa.com:resourcetype">apiversion</ns2:Category>
      </ns2:EntityReference>
    </item>
    <item>
      <title>ACMECorp OpenID API</title>
      <description>OpenID Service</description>
      <category domain="uddi:soa.com:resourcetype">api</category>
      <category domain="uddi:soa.com:visibility">Public</category>
      <guid>api102.acmepaymentscorp</guid>
      <pubDate>Tue, 18 Sep 2012 21:40:27 PDT</pubDate>
      <ns2:EntityReference>
        <Title>ACMECorp OpenID API (1.0)</Title>
        <Guid>apiversion402.acmepaymentscorp</Guid>
        <ns2:Category domain="uddi:soa.com:resourcetype">apiversion</ns2:Category>
      </ns2:EntityReference>
    </item>
    <item>
      <title>Movies</title>
      <description>Interfaces with a movie database for add, modify, delete, and read of movie information.</description>
      <category domain="uddi:soa.com:resourcetype">api</category>
      <category domain="uddi:soa.com:visibility">Public</category>
      <guid>api10041.acmepaymentscorp</guid>
      <pubDate>Wed, 19 Sep 2012 13:51:12 PDT</pubDate>
      <ns2:EntityReference>
        <Title>Movies (1.0)</Title>
        <Guid>apiversion10043.acmepaymentscorp</Guid>
        <ns2:Category domain="uddi:soa.com:resourcetype">apiversion</ns2:Category>
      </ns2:EntityReference>
    </item>
  </channel>
</rss>

Back to top

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

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

Back to top

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 APIs. Each item in the channel represents one API, and includes the information listed below.

Name Description
title The name of the API.
description The text description for the API.
category[ ]

An array of sets of two 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 that the resource is an API.

"value" : "Public",
"domain" : "uddi:soa.com:visibility"

The example above indicates that the API has a visibility setting of Public.

GUID GUID for the resource. It is the unique APIID; for example, api102.acmepaymentscorp.
pubdate The date the RSS channel was generated.
EntityReference

Entity references for the user who is the follower:

  • Title: The name of the API.
  • GUID: unique ID for the API version; the APIVersionID.
  • Category: a set of two name/value pairs expressing information about the API version. For example:
    "value" : "apiversion",
    "domain" : "uddi:soa.com:resourcetype"

    The example above indicates that the resource is an API version.

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