Get API accesses for applications

get

/rest/ofscMetadata/v1/applications/{label}/apiAccess

This operation retrieves the API access information for a collection of applications.

Request

Path Parameters
  • Minimum Length: 1
    Maximum Length: 255
    The label of the API access object.
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : ApplicationApiAccesses
Type: object
The schema of API access objects.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Application
Type: object
Title: Application
Show Source

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to retrieve the collection of API accesses for a specific application by submitting a GET request on the REST resource using cURL:

cURL Command Example

curl -u 'clientId@instance:clientSecret' \
 -X GET \
 --url 'https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess'

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 03 Mar 2016 16:28:18 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Response Body Example

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "label": "partsCatalogAPI",
            "name": "Parts Catalog API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/partsCatalogAPI"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/partsCatalogAPI"
                }
            ]
        },
        {
            "label": "capacityAPI",
            "name": "Capacity API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/capacityAPI"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/capacityAPI"
                }
            ]
        },
        {
            "label": "coreAPI",
            "name": "Core API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/coreAPI"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/coreAPI"
                }
            ]
        },
        {
            "label": "inboundAPI",
            "name": "Inbound Interface API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/inboundAPI"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/inboundAPI"
                }
            ]
        },
        {
            "label": "gpsAPI",
            "name": "GPS API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/gpsAPI"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/gpsAPI"
                }
            ]
        },
        {
            "label": "historyAPI",
            "name": "History API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/historyAPI"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/historyAPI"
                }
            ]
        },
        {
            "label": "metadataAPI",
            "name": "Metadata API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/metadataAPI"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/metadataAPI"
                }
            ]
        },
        {
            "label": "activityManagementAPI",
            "name": "Activity Management API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/activityManagementAPI"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/activityManagementAPI"
                }
            ]
        },
        {
            "label": "outboundAPI",
            "name": "Outbound API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/outboundAPI"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/outboundAPI"
                }
            ]
        },
        {
            "label": "resourceManagementAPI",
            "name": "Resource Management",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/resourceManagementAPI"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/resourceManagementAPI"
                }
            ]
        },
        {
            "label": "smartLocationAPI",
            "name": "Smart Location API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/smartLocationAPI"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/smartLocationAPI"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications"
        }
    ]
}
Back to Top