REST API for Oracle Fusion Field Service Cloud Service

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

label(required): string

Minimum Length: 1

Maximum Length: 255

The label of the API access object.

Response

Supported Media Types

application/schema+json
application/json

200 Response

This section describes the 200 status response for this operation.

Root Schema : ApplicationApiAccesses

Type: object

The schema of API access objects.

Show Source

items: array items

{
    "description":"The schema of API access objects.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationApiAccess"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Application

Title: Application

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApplicationApiAccess"
    }
}

Nested Schema : Application

Type: object

Title: Application

Show Source

label: string

Title: Label

Minimum Length: 1

Maximum Length: 255

The label of the API access object.
name: string

Title: Name

Minimum Length: 1

Maximum Length: 255

The name of the API access object.
status: string

Title: Status

Allowed Values: [ "active", "inactive" ]

The status of the API access object.

{
    "type":"object",
    "title":"Application",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "title":"Label",
            "description":"The label of the API access object."
        },
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "title":"Name",
            "description":"The name of the API access object."
        },
        "status":{
            "type":"string",
            "enum":[
                "active",
                "inactive"
            ],
            "title":"Status",
            "description":"The status of the API access object."
        }
    }
}

Default Response

This section describes the default error response for this operation.

Root Schema : Error

Type: object

Show Source

detail: string

The detailed description of this error.
status: string

The HTTP status code of this error.
title(required): string

The brief description of this error.
type(required): string

The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

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://&lt;instance_name&gt;.fs.ocs.oraclecloud.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>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/534f82a8d1ac2a47da9cfe95a4c8bf9b87b66553/apiAccess/partsCatalogAPI"
                },
                {
                    "rel": "describedby",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/partsCatalogAPI"
                }
            ]
        },
        {
            "label": "capacityAPI",
            "name": "Capacity API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/534f82a8d1ac2a47da9cfe95a4c8bf9b87b66553/apiAccess/capacityAPI"
                },
                {
                    "rel": "describedby",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/capacityAPI"
                }
            ]
        },
        {
            "label": "coreAPI",
            "name": "Core API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/534f82a8d1ac2a47da9cfe95a4c8bf9b87b66553/apiAccess/coreAPI"
                },
                {
                    "rel": "describedby",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/coreAPI"
                }
            ]
        },
        {
            "label": "fieldCollaborationAPI",
            "name": "Field Collaboration API",
            "status": "inactive",
            "links": [
                {
                    "rel": "canonical",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/534f82a8d1ac2a47da9cfe95a4c8bf9b87b66553/apiAccess/fieldCollaborationAPI"
                },
                {
                    "rel": "describedby",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/fieldCollaborationAPI"
                }
            ]
        },
        {
            "label": "inboundAPI",
            "name": "Inbound Interface API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/534f82a8d1ac2a47da9cfe95a4c8bf9b87b66553/apiAccess/inboundAPI"
                },
                {
                    "rel": "describedby",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/inboundAPI"
                }
            ]
        },
        {
            "label": "metadataAPI",
            "name": "Metadata API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/534f82a8d1ac2a47da9cfe95a4c8bf9b87b66553/apiAccess/metadataAPI"
                },
                {
                    "rel": "describedby",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/metadataAPI"
                }
            ]
        },
        {
            "label": "outboundAPI",
            "name": "Outbound API",
            "status": "active",
            "links": [
                {
                    "rel": "canonical",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/534f82a8d1ac2a47da9cfe95a4c8bf9b87b66553/apiAccess/outboundAPI"
                },
                {
                    "rel": "describedby",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/outboundAPI"
                }
            ]
        },
        {
            "label": "statisticsAPI",
            "name": "Statistics API",
            "status": "inactive",
            "links": [
                {
                    "rel": "canonical",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/534f82a8d1ac2a47da9cfe95a4c8bf9b87b66553/apiAccess/statisticsAPI"
                },
                {
                    "rel": "describedby",
                    "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/statisticsAPI"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/534f82a8d1ac2a47da9cfe95a4c8bf9b87b66553/apiAccess"
        },
        {
            "rel": "describedby",
            "href":
"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications"
        }
    ]
}