REST API for Oracle Field Service Cloud Service

Get applications

get

/rest/ofscMetadata/v1/applications

This operation retrieves the list of applications.

Request

Query Parameters

limit: integer

The number of applications to be returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified is 100. If the specified value is greater than 100, zero, or if no value is specified, then it defaults to 100.
offset: integer

The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.

Response

Supported Media Types

application/json
application/schema+json

200 Response

This section describes the 200 status response for this operation.

Root Schema : Applications

Type: object

The schema of the applications.

Show Source

hasMore: boolean

Indicates whether there are more results that can be retrieved with successive paging requests. If the value is true, then there are more results that can be retrieved with successive paging requests. If the value is false or is absent, then there are no more results or this is the final page.
items: array items
limit: integer

The limit value specified in the request. If the limit was not specified or not accepted, the value defaults to 100.
offset: integer

The offset value specified in the request.
totalResults: integer

The total number of the applications in the collection.

{
    "description":"The schema of the applications.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Application"
            }
        },
        "hasMore":{
            "description":"Indicates whether there are more results that can be retrieved with successive paging requests. If the value is true, then there are more results that can be retrieved with successive paging requests. If the value is false or is absent, then there are no more results or this is the final page.",
            "type":"boolean"
        },
        "totalResults":{
            "description":"The total number of the applications in the collection. ",
            "type":"integer"
        },
        "offset":{
            "description":"The offset value specified in the request.",
            "type":"integer"
        },
        "limit":{
            "description":"The limit value specified in the request. If the limit was not specified or not accepted, the value defaults to 100.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Application

Title: Application

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

Nested Schema : Application

Type: object

Title: Application

Show Source

allowedCorsDomains: array Allowed CORS Domains List

Title: Allowed CORS Domains List

Maximum Number of Items: 100

The list of origin domains which are allowed to send requests to Oracle Field Service REST API. The max size of a value is 1020 symbols or 100 domain entries.
IPAddressesToAllow: array IP Addresses To Allow

Title: IP Addresses To Allow

The specified IP addresses accessible to the application. If no IP address is specified, then all IP addresses are accessible.
label: string

Title: Label

Minimum Length: 1

Maximum Length: 255

The label of the application.
name: string

Title: Name

Minimum Length: 1

Maximum Length: 255

The name of the application.
resourcesToAllow: array Resources To Allow

Title: Resources To Allow

The specified resourceInternalIds and resourceIds (external IDs) of resources accessible to the application. The parameter includes all the children of the specified resource. If the resourceInternalIds and resourceIds (external IDs) of resources are not specified, then the application accesses the root resource. If resourceId and resourceInternalId are used in the request parameter, then the application considers the resourceID (unless it is empty).
status: string

Title: Status

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

The status of the application.
tokenService: string

Title: Token Service

Allowed Values: [ "ofsc", "external", "idcs" ]

The token service used by the application.

{
    "type":"object",
    "title":"Application",
    "properties":{
        "label":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "title":"Label",
            "description":"The label of the application."
        },
        "name":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "title":"Name",
            "description":"The name of the application."
        },
        "status":{
            "type":"string",
            "enum":[
                "active",
                "inactive"
            ],
            "title":"Status",
            "description":"The status of the application."
        },
        "tokenService":{
            "type":"string",
            "enum":[
                "ofsc",
                "external",
                "idcs"
            ],
            "title":"Token Service",
            "description":"The token service used by the application."
        },
        "resourcesToAllow":{
            "type":"array",
            "items":{
                "type":"object",
                "title":"Resources To Allow",
                "properties":{
                    "resourceId":{
                        "type":"string",
                        "description":"The resource external ID of the resource that is specified in the resourcesToAllow parameter."
                    },
                    "resourceInternalId":{
                        "type":"integer",
                        "description":"The resource internal ID of the resource that is specified in the resourcesToAllow parameter."
                    }
                }
            },
            "title":"Resources To Allow",
            "description":"The specified resourceInternalIds and resourceIds (external IDs) of resources accessible to the application. The parameter includes all the children of the specified resource. If the resourceInternalIds and resourceIds (external IDs) of resources are not specified, then the application accesses the root resource. If resourceId and resourceInternalId are used in the request parameter, then the application considers the resourceID (unless it is empty)."
        },
        "IPAddressesToAllow":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "title":"IP Addresses To Allow",
            "description":"The specified IP addresses accessible to the application. If no IP address is specified, then all IP addresses are accessible."
        },
        "allowedCorsDomains":{
            "type":"array",
            "maxItems":"100",
            "items":{
                "type":"string",
                "maxLength":"253"
            },
            "title":"Allowed CORS Domains List",
            "description":"The list of origin domains which are allowed to send requests to Oracle Field Service REST API. The max size of a value is 1020 symbols or 100 domain entries."
        }
    }
}

Nested Schema : Allowed CORS Domains List

Type: array

Title: Allowed CORS Domains List

Maximum Number of Items: 100

The list of origin domains which are allowed to send requests to Oracle Field Service REST API. The max size of a value is 1020 symbols or 100 domain entries.

Show Source

Array of: string

Maximum Length: 253

{
    "type":"array",
    "maxItems":"100",
    "items":{
        "type":"string",
        "maxLength":"253"
    },
    "title":"Allowed CORS Domains List",
    "description":"The list of origin domains which are allowed to send requests to Oracle Field Service REST API. The max size of a value is 1020 symbols or 100 domain entries."
}

Nested Schema : IP Addresses To Allow

Type: array

Title: IP Addresses To Allow

The specified IP addresses accessible to the application. If no IP address is specified, then all IP addresses are accessible.

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "title":"IP Addresses To Allow",
    "description":"The specified IP addresses accessible to the application. If no IP address is specified, then all IP addresses are accessible."
}

Nested Schema : Resources To Allow

Type: array

Title: Resources To Allow

The specified resourceInternalIds and resourceIds (external IDs) of resources accessible to the application. The parameter includes all the children of the specified resource. If the resourceInternalIds and resourceIds (external IDs) of resources are not specified, then the application accesses the root resource. If resourceId and resourceInternalId are used in the request parameter, then the application considers the resourceID (unless it is empty).

Show Source

Array of: object Resources To Allow

Title: Resources To Allow

{
    "type":"array",
    "items":{
        "type":"object",
        "title":"Resources To Allow",
        "properties":{
            "resourceId":{
                "type":"string",
                "description":"The resource external ID of the resource that is specified in the resourcesToAllow parameter."
            },
            "resourceInternalId":{
                "type":"integer",
                "description":"The resource internal ID of the resource that is specified in the resourcesToAllow parameter."
            }
        }
    },
    "title":"Resources To Allow",
    "description":"The specified resourceInternalIds and resourceIds (external IDs) of resources accessible to the application. The parameter includes all the children of the specified resource. If the resourceInternalIds and resourceIds (external IDs) of resources are not specified, then the application accesses the root resource. If resourceId and resourceInternalId are used in the request parameter, then the application considers the resourceID (unless it is empty)."
}

Nested Schema : Resources To Allow

Type: object

Title: Resources To Allow

Show Source

resourceId: string

The resource external ID of the resource that is specified in the resourcesToAllow parameter.
resourceInternalId: integer

The resource internal ID of the resource that is specified in the resourcesToAllow parameter.

{
    "type":"object",
    "title":"Resources To Allow",
    "properties":{
        "resourceId":{
            "type":"string",
            "description":"The resource external ID of the resource that is specified in the resourcesToAllow parameter."
        },
        "resourceInternalId":{
            "type":"integer",
            "description":"The resource internal ID of the resource that is specified in the resourcesToAllow parameter."
        }
    }
}

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 configured applications from OFSC 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'

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.

{
    "hasMore": false,
    "totalResults": 9,
    "limit": 100,
    "offset": 0,
    "items": [
        {
            "label": "34115924505effa92e8c9763b38be7646719a385",
            "name": "App soap",
            "status": "active",
            "tokenService": "ofsc",
            "resourcesToAllow": [],
            "IPAddressesToAllow": [],
            "allowedCorsDomains": ["https://best.customer.01.dot.com", "https://example.com"],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/34115924505effa92e8c9763b38be7646719a385"
                },
                {
                    "rel": "apiAccess",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/34115924505effa92e8c9763b38be7646719a385/apiAccess"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications"
                }
            ]
        },
        {
            "label": "a6b0b3b93caec0b228bf6c4e52b2828cd0837d1e",
            "name": "App ODI_Soap",
            "status": "active",
            "tokenService": "ofsc",
            "resourcesToAllow": [],
            "IPAddressesToAllow": [],
            "allowedCorsDomains": ["https://best.customer.01.dot.com", "https://example.com"],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/a6b0b3b93caec0b228bf6c4e52b2828cd0837d1e"
                },
                {
                    "rel": "apiAccess",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/a6b0b3b93caec0b228bf6c4e52b2828cd0837d1e/apiAccess"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications"
                }
            ]
        },
        {
            "label": "73e3a9b4a830f4a478d135976570d1545a9d77ef",
            "name": "App Administrador OOEE-GAS",
            "status": "active",
            "tokenService": "ofsc",
            "resourcesToAllow": [],
            "IPAddressesToAllow": [],
            "allowedCorsDomains": ["https://best.customer.01.dot.com", "https://example.com"],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/73e3a9b4a830f4a478d135976570d1545a9d77ef"
                },
                {
                    "rel": "apiAccess",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/73e3a9b4a830f4a478d135976570d1545a9d77ef/apiAccess"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications"
                }
            ]
        },
        {
            "label": "5afbd589dd6042de63507621940f2f3a4a477fb6",
            "name": "App UT24_DISPLAY_PROFILE",
            "status": "active",
            "tokenService": "ofsc",
            "resourcesToAllow": [],
            "IPAddressesToAllow": [],
            "allowedCorsDomains": ["https://best.customer.01.dot.com", "https://example.com"],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6"
                },
                {
                    "rel": "apiAccess",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications"
                }
            ]
        }
    ]
}