GET /api/apis/versions/{APIVersionID}/connectedapps

Returns a list of apps that are connected to the specified API version.

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}/connectedapps[?][ActivatedOnly={Boolean}]
&[Environment={Environment}]&[IncludeActions={Boolean}]

Sample Request

The example below shows a request for the connected apps for the specified API version.

Sample Request URL 

https://{hostname}/api/apis/versions/apiversion19126.acmepaymentscorp/connectedapps

Sample request headers 

GET http://acmepaymentscorp.com/api/apis/versions/facf4025-5a72-46aa-a61e-1f5172647682.acmepaymentscorp/connectedapps HTTP/1.0
Host: acmepaymentscorp.com
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/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
APIVersionID Path string Required The unique ID for a specific API version.
ActivatedOnly Query boolean Optional Indicates whether only connected apps with activated contracts should be included in the information returned. If not specified, all are returned.
Environment Query string Optional The environment (implementation) (Sandbox or Production). If specified, returns only apps connected for that environment. If not specified, all are returned.
IncludeActions Query boolean Optional Indicates whether workflow actions currently valid for the resource should be included in the results. Default: false. For valid workflow actions, see Workflow Actions.

Response

If successful, this operation returns HTTP status code 200, with the list of connected apps returned as an RSS feed in XML or JSON format.

Sample Response

The sample response below shows that there are 2 apps connected to the specified API.

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

HTTP/1.1 200 OK
Date: Mon, 02 Jul 2018 22:15:13 GMT
Content-Type: application/vnd.soa.v81+json

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

{
  "channel":{
    "title":"Apps Connected",
    "item":[
      {
        "title":"9d50e439-2e50-4393-8053-f47706006f20.acmepaymentscorp",
        "category":[
          {
            "value":"Production",
            "domain":"uddi:soa.com:environment"
          },
          {
            "value":"apicontract.status.activated",
            "domain":"uddi:soa.com:wfstate"
          },
          {
            "value":"com.soa.apicontract.inforce",
            "domain":"uddi:soa.com:status"
          },
          {
            "value":"false",
            "domain":"uddi:soa.com:restrictedscope"
          }
        ],
        "guid":{
          "value":"9d50e439-2e50-4393-8053-f47706006f20.acmepaymentscorp"
        },
        "EntityReferences":{
          "EntityReference":[
            {
              "Title":"v1",
              "Guid":"cd423b31-16f9-4f3d-8882-72f69ef13302.acmepaymentscorp",
              "Category":[
                {
                  "value":"apiversion",
                  "domain":"uddi:soa.com:resourcetype"
                },
                {
                  "value":"Public",
                  "domain":"uddi:soa.com:visibility"
                },
                {
                  "value":"uddi:soa.com:api:resource-level-permissions-notsupported",
                  "domain":"uddi:soa.com:api:resource-level-permissions"
                }
              ]
            },
            {
              "Title":"Swagger_Petstore_Subset",
              "Guid":"09f82858-aa96-47af-85f7-4e1c40c2b657.acmepaymentscorp",
              "Category":[
                {
                  "value":"api",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            },
            {
              "Title":"1.0",
              "Guid":"ZynDtOcZoqJCQ6Rcp6Ij8LZprHIC0adx2zi7qh1c.acmepaymentscorp",
              "Category":[
                {
                  "value":"app-version",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            },
            {
              "Title":"App GenTest Postman",
              "Guid":"5ebd683b-5509-4dfc-8ad8-03a76686da6d.acmepaymentscorp",
              "Category":[
                {
                  "value":"app",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            },
            {
              "Guid":"contract_request10353.acmepaymentscorp",
              "Category":[
                {
                  "value":"board-item",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            }
          ]
        },
        "Image":[
          {
            "Url":"http://acmepaymentscorp.com/api/apis/avatar/_VYOYCjcINs6JPVByUx741oA",
            "Title":"api",
            "Link":"#/api/09f82858-aa96-47af-85f7-4e1c40c2b657.acmepaymentscorp/versions/cd423b31-16f9-4f3d-8882-72f69ef13302.acmepaymentscorp/details"
          },
          {
            "Url":"http://acmepaymentscorp.com/api/apps/avatar/_VYOYCjcINs6JPVByUx741oA",
            "Title":"app",
            "Link":"#/app/5ebd683b-5509-4dfc-8ad8-03a76686da6d.acmepaymentscorp/versions/ZynDtOcZoqJCQ6Rcp6Ij8LZprHIC0adx2zi7qh1c.acmepaymentscorp/details"
          }
        ]
      },
      {
        "title":"5ec34817-2847-4571-a3e4-ab130e069f27.acmepaymentscorp",
        "category":[
          {
            "value":"Production",
            "domain":"uddi:soa.com:environment"
          },
          {
            "value":"apicontract.status.activated",
            "domain":"uddi:soa.com:wfstate"
          },
          {
            "value":"com.soa.apicontract.inforce",
            "domain":"uddi:soa.com:status"
          },
          {
            "value":"false",
            "domain":"uddi:soa.com:restrictedscope"
          }
        ],
        "guid":{
          "value":"5ec34817-2847-4571-a3e4-ab130e069f27.acmepaymentscorp"
        },
        "EntityReferences":{
          "EntityReference":[
            {
              "Title":"v1",
              "Guid":"cd423b31-16f9-4f3d-8882-72f69ef13302.acmepaymentscorp",
              "Category":[
                {
                  "value":"apiversion",
                  "domain":"uddi:soa.com:resourcetype"
                },
                {
                  "value":"Public",
                  "domain":"uddi:soa.com:visibility"
                },
                {
                  "value":"uddi:soa.com:api:resource-level-permissions-notsupported",
                  "domain":"uddi:soa.com:api:resource-level-permissions"
                }
              ]
            },
            {
              "Title":"Swagger_Petstore_Subset",
              "Guid":"09f82858-aa96-47af-85f7-4e1c40c2b657.acmepaymentscorp",
              "Category":[
                {
                  "value":"api",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            },
            {
              "Title":"1.0",
              "Guid":"CPojfy6EdGprUugabflFTbfZCtXtfvaJOWeXfWjB.acmepaymentscorp",
              "Category":[
                {
                  "value":"app-version",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            },
            {
              "Title":"Crosfhocal",
              "Guid":"7aac1e1b-321f-49e9-b3f0-a820b277223c.acmepaymentscorp",
              "Category":[
                {
                  "value":"app",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            },
            {
              "Guid":"contract_request10356.acmepaymentscorp",
              "Category":[
                {
                  "value":"board-item",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            }
          ]
        },
        "Image":[
          {
            "Url":"http://acmepaymentscorp.com/api/apis/avatar/_VYOYCjcINs6JPVByUx741oA",
            "Title":"api",
            "Link":"#/api/09f82858-aa96-47af-85f7-4e1c40c2b657.acmepaymentscorp/versions/cd423b31-16f9-4f3d-8882-72f69ef13302.acmepaymentscorp/details"
          },
          {
            "Url":"http://acmepaymentscorp.com/api/apps/avatar/_VYOYCjcINs6JPVByUx741oA",
            "Title":"app",
            "Link":"#/app/7aac1e1b-321f-49e9-b3f0-a820b277223c.acmepaymentscorp/versions/CPojfy6EdGprUugabflFTbfZCtXtfvaJOWeXfWjB.acmepaymentscorp/details"
          }
        ]
      }
    ]
  },
  "version":"1.0"
}

The sample response below shows that there are 2 apps connected to the specified API.

Sample response headers 

HTTP/1.1 200 OK
Date:  Mon, 02 Jul 2018 22:20:28 GMT
Content-Type: application/vnd.soa.v81+xml

Sample response body 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rss xmlns:ns2="http://soa.com/xsd/business/1.0" xmlns:ns3="http://soa.com/xsd/user/1.0" xmlns:ns4="http://soa.com/xsd/rss/1.0" xmlns:ns5="http://soa.com/xsd/comment/1.0" xmlns:ns6="http://soa.com/xsd/board/1.0" xmlns:ns7="http://soa.com/xsd/dnmodel/1.0" xmlns:ns8="http://a9.com/-/spec/opensearch/1.1/" xmlns:ns9="http://soa.com/xsd/resource/1.0" xmlns:ns10="http://soa.com/xsd/legals/1.0" xmlns:ns11="http://soa.com/xsd/fault/1.0" xmlns:ns12="http://soa.com/xsd/api/1.0" xmlns:ns13="http://soa.com/xsd/deploymentzone/1.0" xmlns:ns14="http://soa.com/xsd/asset/1.0" xmlns:ns15="http://soa.com/xsd/ticket/1.0" xmlns:ns16="http://soa.com/xsd/app/1.0" xmlns:ns17="http://soa.com/xsd/review/1.0" xmlns:ns18="http://soa.com/xsd/alert/1.0" xmlns:ns19="http://soa.com/xsd/contract/1.0" xmlns:ns20="http://soa.com/xsd/discussion/1.0" xmlns:ns21="http://soa.com/xsd/search/1.0" xmlns:ns22="http://soa.com/xsd/workflow/1.0" xmlns:ns23="http://soa.com/xsd/client/services/1.0" xmlns:ns24="http://soa.com/xsd/oauth/1.0" version="1.0">
  <channel>
    <title>Apps Connected</title>
    <item>
      <title>9d50e439-2e50-4393-8053-f47706006f20.acmepaymentscorp</title>
      <category domain="uddi:soa.com:environment">Production</category>
      <category domain="uddi:soa.com:wfstate">apicontract.status.activated</category>
      <category domain="uddi:soa.com:status">com.soa.apicontract.inforce</category>
      <category domain="uddi:soa.com:restrictedscope">false</category>
      <guid>9d50e439-2e50-4393-8053-f47706006f20.acmepaymentscorp</guid>
      <ns4:EntityReferences>
        <ns4:EntityReference>
          <Title>v1</Title>
          <Guid>cd423b31-16f9-4f3d-8882-72f69ef13302.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">apiversion</ns4:Category>
          <ns4:Category domain="uddi:soa.com:visibility">Public</ns4:Category>
          <ns4:Category domain="uddi:soa.com:api:resource-level-permissions">uddi:soa.com:api:resource-level-permissions-notsupported</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>Swagger_Petstore_Subset</Title>
          <Guid>09f82858-aa96-47af-85f7-4e1c40c2b657.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">api</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>1.0</Title>
          <Guid>ZynDtOcZoqJCQ6Rcp6Ij8LZprHIC0adx2zi7qh1c.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>App GenTest Postman</Title>
          <Guid>5ebd683b-5509-4dfc-8ad8-03a76686da6d.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">app</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Guid>contract_request10353.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">board-item</ns4:Category>
        </ns4:EntityReference>
      </ns4:EntityReferences>
      <ns4:Image>
        <Url>http://testing.acmepaymentscorp.com/api/apis/avatar/_VYOYCjcINs6JPVByUx741oA</Url>
        <Title>api</Title>
        <Link>#/api/09f82858-aa96-47af-85f7-4e1c40c2b657.acmepaymentscorp/versions/cd423b31-16f9-4f3d-8882-72f69ef13302.acmepaymentscorp/details</Link>
      </ns4:Image>
      <ns4:Image>
        <Url>http://acmepaymentscorp.com/api/apps/avatar/_VYOYCjcINs6JPVByUx741oA</Url>
        <Title>app</Title>
        <Link>#/app/5ebd683b-5509-4dfc-8ad8-03a76686da6d.acmepaymentscorp/versions/ZynDtOcZoqJCQ6Rcp6Ij8LZprHIC0adx2zi7qh1c.acmepaymentscorp/details</Link>
      </ns4:Image>
    </item>
    <item>
      <title>5ec34817-2847-4571-a3e4-ab130e069f27.acmepaymentscorp</title>
      <category domain="uddi:soa.com:environment">Production</category>
      <category domain="uddi:soa.com:wfstate">apicontract.status.activated</category>
      <category domain="uddi:soa.com:status">com.soa.apicontract.inforce</category>
      <category domain="uddi:soa.com:restrictedscope">false</category>
      <guid>5ec34817-2847-4571-a3e4-ab130e069f27.acmepaymentscorp</guid>
      <ns4:EntityReferences>
        <ns4:EntityReference>
          <Title>v1</Title>
          <Guid>cd423b31-16f9-4f3d-8882-72f69ef13302.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">apiversion</ns4:Category>
          <ns4:Category domain="uddi:soa.com:visibility">Public</ns4:Category>
          <ns4:Category domain="uddi:soa.com:api:resource-level-permissions">uddi:soa.com:api:resource-level-permissions-notsupported</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>Swagger_Petstore_Subset</Title>
          <Guid>09f82858-aa96-47af-85f7-4e1c40c2b657.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">api</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>1.0</Title>
          <Guid>CPojfy6EdGprUugabflFTbfZCtXtfvaJOWeXfWjB.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Title>Crosfhocal</Title>
          <Guid>7aac1e1b-321f-49e9-b3f0-a820b277223c.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">app</ns4:Category>
        </ns4:EntityReference>
        <ns4:EntityReference>
          <Guid>contract_request10356.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">board-item</ns4:Category>
        </ns4:EntityReference>
      </ns4:EntityReferences>
      <ns4:Image>
        <Url>http://acmepaymentscorp.com/api/apis/avatar/_VYOYCjcINs6JPVByUx741oA</Url>
        <Title>api</Title>
        <Link>#/api/09f82858-aa96-47af-85f7-4e1c40c2b657.acmepaymentscorp/versions/cd423b31-16f9-4f3d-8882-72f69ef13302.acmepaymentscorp/details</Link>
      </ns4:Image>
      <ns4:Image>
        <Url>http://acmepaymentscorp.com/api/apps/avatar/_VYOYCjcINs6JPVByUx741oA</Url>
        <Title>app</Title>
        <Link>#/app/7aac1e1b-321f-49e9-b3f0-a820b277223c.acmepaymentscorp/versions/CPojfy6EdGprUugabflFTbfZCtXtfvaJOWeXfWjB.acmepaymentscorp/details</Link>
      </ns4:Image>
    </item>
  </channel>
</rss>

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

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 Apps Connected. Each item in the channel represents an app that is connected to the specified API, and includes the information listed below.

Name Description
title The unique ContractID for the app/API contract; for example, contract23622.acmepaymentscorp.
category

One or more categories. Each category is a set of two name/value pairs. The second item defines the domain for the property, and the first defines the actual value for the property. For example, the set of values below shows that the contract applies to the Sandbox implementation:

"value" : "Sandbox",
"domain" : "uddi:soa.com:environment"

The above indicates that the contract applies to the Sandbox implementation.
guid GUID for the connection. This is the unique ContractID for the app/API contract.
Endpoints

An array of name/value pair sets containing information about the endpoints that the connection applies to.

Each includes Category, which is the implementation for the endpoint, 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.
Image [ ]

An array containing information about the image for each of the avatars associated with the contract. There can be one avatar for the app and one for the API. For each avatar, the image information includes:

  • URL: The URL of the avatar.
  • Title: The title of the resource the avatar is for; app or api.
  • Link: A relative link to the Board for the resource.
Actions

An array of name/value pair sets containing information about one or more action events that are valid for the item. Each includes value and label, and both contain the name of the valid action. For example:

"value" : "apicontract.action.suspend",
"label" : "apicontract.action.suspend"

The example above indicates that Suspend is a valid action for the contract.
EntityReferences

Information about one or more platform entities that information in the RSS channel applies to. Each includes:

  • Title: The title of the entity.
  • GUID: GUID for the entity.
  • Category[ ]: an array of name/value pairs containing information about the app/API contract.

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.