REST API for Oracle Field Service Cloud Service

Get API access for an application

get

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

This operation retrieves the API access information of an application based on the specified API label and the application ID specified while creating the application.

Request

Path Parameters

apiLabel(required): string

Minimum Length: 1

Maximum Length: 255

The label used to identify the API.

Allowed Values: [ "partsCatalogAPI", "capacityAPI", "coreAPI", "fieldCollaborationAPI", "inboundAPI", "metadataAPI", "outboundAPI", "statisticsAPI" ]
label(required): string

Minimum Length: 1

Maximum Length: 255

The label used to retrieve the API access information of the application.

Response

Supported Media Types

application/json
application/schema+json

200 Response

This section describes the 200 status response for this operation.

Root Schema : Application

Type: object

Title: Application

Show Source

activityFields: array Activity Fields

Title: Activity Fields

The activity fields of the Inbound API specified in the request.
apiEntities: array API Entities

Title: API Entities

The entities of Core API or Metadata API specified in the request.
apiMethods: array API Methods

Title: API Methods

The methods Capacity API specified in the request.
inventoryFields: array Inventory Fields

Title: Inventory Fields

The inventory fields of the Inbound Interface API specified in the request.
label: string

Title: Label

Minimum Length: 1

Maximum Length: 255

The label of the API.
name: string

Title: Name

Minimum Length: 1

Maximum Length: 255

The name of the API.
providerFields: array Provider Fields

Title: Provider Fields

The provider fields of the Inbound Interface API specified in the request.
requestFields: array Request Fields

Title: Request Fields

Not used. The request fields visibility is not applicable for any API.
status: string

Title: Status

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

The status set for the application.
userFields: array User Fields

Title: User Fields

Not used. The user fields visibility is not applicable for any API.

{
    "type":"object",
    "title":"Application",
    "properties":{
        "label":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "title":"Label",
            "description":"The label of the API."
        },
        "name":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "title":"Name",
            "description":"The name of the API."
        },
        "status":{
            "type":"string",
            "enum":[
                "active",
                "inactive"
            ],
            "title":"Status",
            "description":"The status set for the application."
        },
        "apiMethods":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationApiAccessMethod"
            },
            "title":"API Methods",
            "description":"The methods Capacity API specified in the request."
        },
        "apiEntities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationApiAccessEntity"
            },
            "title":"API Entities",
            "description":" The entities of Core API or Metadata API specified in the request."
        },
        "activityFields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationApiAccessContext"
            },
            "title":"Activity Fields",
            "description":"The activity fields of the Inbound API specified in the request."
        },
        "inventoryFields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationApiAccessContext"
            },
            "title":"Inventory Fields",
            "description":"The inventory fields of the Inbound Interface API specified in the request."
        },
        "providerFields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationApiAccessContext"
            },
            "title":"Provider Fields",
            "description":"The provider fields of the Inbound Interface API specified in the request."
        },
        "userFields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationApiAccessContextUser"
            },
            "title":"User Fields",
            "description":"Not used. The user fields visibility is not applicable for any API."
        },
        "requestFields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationApiAccessContext"
            },
            "title":"Request Fields",
            "description":"Not used. The request fields visibility is not applicable for any API."
        }
    }
}

Nested Schema : Activity Fields

Type: array

Title: Activity Fields

The activity fields of the Inbound API specified in the request.

Show Source

Array of: object ApplicationApiAccessContext

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApplicationApiAccessContext"
    },
    "title":"Activity Fields",
    "description":"The activity fields of the Inbound API specified in the request."
}

Nested Schema : API Entities

Type: array

Title: API Entities

The entities of Core API or Metadata API specified in the request.

Show Source

Array of: object ApplicationApiAccessEntity

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApplicationApiAccessEntity"
    },
    "title":"API Entities",
    "description":" The entities of Core API or Metadata API specified in the request."
}

Nested Schema : API Methods

Type: array

Title: API Methods

The methods Capacity API specified in the request.

Show Source

Array of: object ApplicationApiAccessMethod

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApplicationApiAccessMethod"
    },
    "title":"API Methods",
    "description":"The methods Capacity API specified in the request."
}

Nested Schema : Inventory Fields

Type: array

Title: Inventory Fields

The inventory fields of the Inbound Interface API specified in the request.

Show Source

Array of: object ApplicationApiAccessContext

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApplicationApiAccessContext"
    },
    "title":"Inventory Fields",
    "description":"The inventory fields of the Inbound Interface API specified in the request."
}

Nested Schema : Provider Fields

Type: array

Title: Provider Fields

The provider fields of the Inbound Interface API specified in the request.

Show Source

Array of: object ApplicationApiAccessContext

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApplicationApiAccessContext"
    },
    "title":"Provider Fields",
    "description":"The provider fields of the Inbound Interface API specified in the request."
}

Nested Schema : Request Fields

Type: array

Title: Request Fields

Not used. The request fields visibility is not applicable for any API.

Show Source

Array of: object ApplicationApiAccessContext

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApplicationApiAccessContext"
    },
    "title":"Request Fields",
    "description":"Not used. The request fields visibility is not applicable for any API."
}

Nested Schema : User Fields

Type: array

Title: User Fields

Not used. The user fields visibility is not applicable for any API.

Show Source

Array of: object ApplicationApiAccessContextUser

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApplicationApiAccessContextUser"
    },
    "title":"User Fields",
    "description":"Not used. The user fields visibility is not applicable for any API."
}

Nested Schema : ApplicationApiAccessContext

Type: object

Show Source

label: string

Minimum Length: 1

Maximum Length: 255

The label of the activity property.
valuesVisibility: array valuesVisibility

The visibility settings for each property.
visibilities: array visibilities

The visibility settings for each field.

{
    "properties":{
        "label":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "description":"The label of the activity property. "
        },
        "visibilities":{
            "type":"array",
            "description":"The visibility settings for each field.",
            "items":{
                "type":"object",
                "properties":{
                    "visibility":{
                        "description":"The visibility settings defined for an activity field.",
                        "type":"string",
                        "enum":[
                            "ReadOnly",
                            "ReadWrite",
                            "Mandatory"
                        ]
                    },
                    "conditions":{
                        "$ref":"#/definitions/ApplicationApiAccessContextConditions"
                    }
                }
            }
        },
        "valuesVisibility":{
            "type":"array",
            "description":"The visibility settings for each property. ",
            "items":{
                "type":"object",
                "properties":{
                    "value":{
                        "description":"The value set for the property.",
                        "type":"string"
                    },
                    "conditions":{
                        "description":"The conditions under which the value is available.",
                        "$ref":"#/definitions/ApplicationApiAccessContextConditions"
                    }
                }
            }
        }
    }
}

Nested Schema : valuesVisibility

Type: array

The visibility settings for each property.

Show Source

Array of: object items

{
    "type":"array",
    "description":"The visibility settings for each property. ",
    "items":{
        "type":"object",
        "properties":{
            "value":{
                "description":"The value set for the property.",
                "type":"string"
            },
            "conditions":{
                "description":"The conditions under which the value is available.",
                "$ref":"#/definitions/ApplicationApiAccessContextConditions"
            }
        }
    }
}

Nested Schema : visibilities

Type: array

The visibility settings for each field.

Show Source

Array of: object items

{
    "type":"array",
    "description":"The visibility settings for each field.",
    "items":{
        "type":"object",
        "properties":{
            "visibility":{
                "description":"The visibility settings defined for an activity field.",
                "type":"string",
                "enum":[
                    "ReadOnly",
                    "ReadWrite",
                    "Mandatory"
                ]
            },
            "conditions":{
                "$ref":"#/definitions/ApplicationApiAccessContextConditions"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

conditions: array ApplicationApiAccessContextConditions
value: string

The value set for the property.

{
    "type":"object",
    "properties":{
        "value":{
            "description":"The value set for the property.",
            "type":"string"
        },
        "conditions":{
            "description":"The conditions under which the value is available.",
            "$ref":"#/definitions/ApplicationApiAccessContextConditions"
        }
    }
}

Nested Schema : ApplicationApiAccessContextConditions

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"The label of the property specified for the application.",
                "type":"string",
                "minLength":"1",
                "maxLength":"40"
            },
            "function":{
                "description":"The function used by the condition to display the property.",
                "type":"string",
                "enum":[
                    "in",
                    "not_in",
                    "contains",
                    "dcontain",
                    "is_null",
                    "is_not_null"
                ]
            },
            "value":{
                "description":"The value used by the condition to test a function.",
                "type":"string"
            },
            "valueList":{
                "description":"The list of values used by the condition to test a function.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "required":[
            "label",
            "function"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

function(required): string

Allowed Values: [ "in", "not_in", "contains", "dcontain", "is_null", "is_not_null" ]

The function used by the condition to display the property.
label(required): string

Minimum Length: 1

Maximum Length: 40

The label of the property specified for the application.
value: string

The value used by the condition to test a function.
valueList: array valueList

The list of values used by the condition to test a function.

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the property specified for the application.",
            "type":"string",
            "minLength":"1",
            "maxLength":"40"
        },
        "function":{
            "description":"The function used by the condition to display the property.",
            "type":"string",
            "enum":[
                "in",
                "not_in",
                "contains",
                "dcontain",
                "is_null",
                "is_not_null"
            ]
        },
        "value":{
            "description":"The value used by the condition to test a function.",
            "type":"string"
        },
        "valueList":{
            "description":"The list of values used by the condition to test a function.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "label",
        "function"
    ]
}

Nested Schema : valueList

Type: array

The list of values used by the condition to test a function.

Show Source

Array of: string

{
    "description":"The list of values used by the condition to test a function.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

conditions: array ApplicationApiAccessContextConditions
visibility: string

Allowed Values: [ "ReadOnly", "ReadWrite", "Mandatory" ]

The visibility settings defined for an activity field.

{
    "type":"object",
    "properties":{
        "visibility":{
            "description":"The visibility settings defined for an activity field.",
            "type":"string",
            "enum":[
                "ReadOnly",
                "ReadWrite",
                "Mandatory"
            ]
        },
        "conditions":{
            "$ref":"#/definitions/ApplicationApiAccessContextConditions"
        }
    }
}

Nested Schema : ApplicationApiAccessEntity

Type: object

Show Source

access: string

Allowed Values: [ "ReadOnly", "ReadWrite", "Hidden" ]

The visibility set for the entity.
label: string

Minimum Length: 1

Maximum Length: 80

The label of the entity.

{
    "properties":{
        "label":{
            "description":"The label of the entity.",
            "type":"string",
            "minLength":"1",
            "maxLength":"80"
        },
        "access":{
            "description":"The visibility set for the entity.",
            "type":"string",
            "enum":[
                "ReadOnly",
                "ReadWrite",
                "Hidden"
            ]
        }
    }
}

Nested Schema : ApplicationApiAccessMethod

Type: object

Show Source

label: string

Minimum Length: 1

Maximum Length: 80

The label of the API method.
status: string

Allowed Values: [ "on", "off" ]

The status of the API method.

{
    "properties":{
        "label":{
            "description":"The label of the API method.",
            "type":"string",
            "minLength":"1",
            "maxLength":"80"
        },
        "status":{
            "description":"The status of the API method.",
            "type":"string",
            "enum":[
                "on",
                "off"
            ]
        }
    }
}

Nested Schema : ApplicationApiAccessContextUser

Type: object

Show Source

label: string

Minimum Length: 1

Maximum Length: 255

The label of the user property.
visibilities: array visibilities

{
    "properties":{
        "label":{
            "type":"string",
            "description":"The label of the user property.",
            "minLength":"1",
            "maxLength":"255"
        },
        "visibilities":{
            "type":"array",
            "items":{
                "type":"object",
                "description":"The collection of visibility settings for the property. ",
                "properties":{
                    "visibility":{
                        "description":"The visibility value assigned to the property.",
                        "type":"string",
                        "enum":[
                            "ReadOnly",
                            "ReadWrite",
                            "Mandatory"
                        ]
                    }
                }
            }
        }
    }
}

Nested Schema : visibilities

Type: array

Show Source

Array of: object items

The collection of visibility settings for the property.

{
    "type":"array",
    "items":{
        "type":"object",
        "description":"The collection of visibility settings for the property. ",
        "properties":{
            "visibility":{
                "description":"The visibility value assigned to the property.",
                "type":"string",
                "enum":[
                    "ReadOnly",
                    "ReadWrite",
                    "Mandatory"
                ]
            }
        }
    }
}

Nested Schema : items

Type: object

The collection of visibility settings for the property.

Show Source

visibility: string

Allowed Values: [ "ReadOnly", "ReadWrite", "Mandatory" ]

The visibility value assigned to the property.

{
    "type":"object",
    "description":"The collection of visibility settings for the property. ",
    "properties":{
        "visibility":{
            "description":"The visibility value assigned to the property.",
            "type":"string",
            "enum":[
                "ReadOnly",
                "ReadWrite",
                "Mandatory"
            ]
        }
    }
}

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 API access (based on entities) 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>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/metadataAPI'

Response Body Example

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
{
    "label": "metadataAPI",
    "name": "Metadata API",
    "status": "active",
    "apiEntities": [
        {
            "label": "metadata_api_activity_type",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_applications",
            "access": "ReadWrite"
        },
        {
            "label": "metadata_api_capacity_area",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_capacity_category",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_map_layers",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_non_working_reasons",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_organizations",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_property",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_work_skill",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_workzone",
            "access": "Hidden"
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/metadata_api"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/metadata_api"
        }
    ]
}