REST API for Oracle Field Service Cloud Service

Get a list of forms

get

/rest/ofscMetadata/v1/forms

This operation retrieves a list of forms in the Oracle Field Service application.

Request

Query Parameters

language: string
The translation language code. Based on the value of this parameter, the translation for the name of the form is returned in the 'name' field.
- If the value is specified, then the translated value is returned in the 'name' field and the 'translations' field is not returned in the response.
- If translation for the specified language does not exist, then the value in the 'name' field is returned in English.
- If the value is not specified, then the 'translations' field is returned in the response and contains the translations to every language in the system.
For the list of supported language codes, see Supported Language Codes.
limit: integer

Minimum Value: 1

Maximum Value: 100

The number of form records 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

Minimum Value: 0

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 : Forms

Type: object

Title: Forms

The collection of forms. It is not returned for an empty collection.

Show Source

hasMore: boolean

Title: Has More

Contains one of the following values: true or false.
If true, then there are more results that can be retrieved with successive paging requests.
If false or if the value is not present, then there are no more results or this is the final page. The default value is true.
items: array Items

Title: Items

The collection of forms.
limit: integer

Title: Limit

The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100.
offset: integer

Title: Offset

The offset value specified in the request.
totalResults: integer

Title: Total Results

The total number of form records in the collection.

{
    "type":"object",
    "title":"Forms",
    "description":"The collection of forms. It is not returned for an empty collection.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Form"
            },
            "title":"Items",
            "description":"The collection of forms."
        },
        "totalResults":{
            "type":"integer",
            "title":"Total Results",
            "description":"The total number of form records in the collection. "
        },
        "hasMore":{
            "type":"boolean",
            "title":"Has More",
            "description":"Contains one of the following values: true or false.<p>If true, then there are more results that can be retrieved with successive paging requests.</p><p>If false or if the value is not present, then there are no more results or this is the final page. The default value is true.</p>"
        },
        "offset":{
            "type":"integer",
            "title":"Offset",
            "description":"The offset value specified in the request."
        },
        "limit":{
            "type":"integer",
            "title":"Limit",
            "description":"The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The collection of forms.

Show Source

Array of: object Form

Title: Form

The form entity in the Oracle Field Service application.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Form"
    },
    "title":"Items",
    "description":"The collection of forms."
}

Nested Schema : Form

Type: object

Title: Form

The form entity in the Oracle Field Service application.

Show Source

label(required): string

Title: Label

Minimum Length: 1

Maximum Length: 40

The label of the form.
name(required): string

Title: Name

Minimum Length: 1

Maximum Length: 255

The translation of the name of the form to the specified language.
translations: array Translations

Title: Translations

The list of associated translations that is returned for the name of the form. The list is only returned if the language parameter is not specified in the request.

{
    "type":"object",
    "title":"Form",
    "description":"The form entity in the Oracle Field Service application.",
    "properties":{
        "label":{
            "type":"string",
            "minLength":"1",
            "maxLength":"40",
            "title":"Label",
            "description":"The label of the form."
        },
        "name":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "title":"Name",
            "description":"The translation of the name of the form to the specified language."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The list of associated translations that is returned for the name of the form. The list is only returned if the language parameter is not specified in the request."
        }
    },
    "required":[
        "label",
        "name"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The list of associated translations that is returned for the name of the form. The list is only returned if the language parameter is not specified in the request.

Show Source

Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"The list of associated translations that is returned for the name of the form. The list is only returned if the language parameter is not specified in the request."
}

Nested Schema : Translation

Type: object

Show Source

language(required): string

This field contains language code of a text translation, it conatains two characters length code in responses (e.g. 'en', 'es') but can be used in requests as extended ISO code (e.g. 'en-US') as well as old two character format.
languageISO: string

This field is used only in responses and returns ISO language code (e.g. 'en-US'). This field is ignored in the requests (use 'language' instead)
name(required): string

{
    "properties":{
        "language":{
            "description":"This field contains language code of a text translation, it conatains two characters length code in responses (e.g. 'en', 'es') but can be used in requests as extended ISO code (e.g. 'en-US') as well as old two character format.",
            "type":"string"
        },
        "languageISO":{
            "description":"This field is used only in responses and returns ISO language code (e.g. 'en-US'). This field is ignored in the requests (use 'language' instead)",
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

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

Example 1

The following example shows how to obtain a list of forms with the GET request on the REST resource using cURL.

cURL command Example

The following shows an example of the cURL command.

curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' -H 'Accept: application/json' 'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms/?limit=2&offset=2'

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 24 Jan 2018 12: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": true,
    "totalResults": 5,
    "limit": 2,
    "offset": 2,
    "items": [
        {
            "label": "mob_inv",
            "name": "Mob Inv",
            "translations": [
                {
                    "language": "en",
                    "name": "Mob Inv",
                    "languageISO": "en-US"
                },
                {
                    "language": "es",
                    "name": "Mob EQ",
                    "languageISO": "es-ES"
                }
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms/mob_inv"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/forms"
                }
            ]
        },
        {
            "label": "hi_inv",
            "name": "Hi Inv",
            "translations": [
                {
                    "language": "en",
                    "name": "Hi Inv",
                    "languageISO": "en-US"
                },
                {
                    "language": "es",
                    "name": "Hi EQ",
                    "languageISO": "es-ES"
                }
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms/hi_inv"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/forms"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms?limit=2&offset=2"
        },
        {
            "rel": "prev",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms?limit=2&offset=0"
        },
        {
            "rel": "next",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms?limit=2&offset=4"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/forms"
        }
    ]
}

Example 2

The following example shows how to obtain form attributes by using the language parameter with the GET request on the REST resource using cURL.

cURL command Example

The following shows an example of the cURL command.

curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' -H 'Accept: application/json' 'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms/?language=en-US&limit=2&offset=2'

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 24 Jan 2018 12: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": true,
    "totalResults": 5,
    "limit": 2,
    "offset": 2,
    "items": [
        {
            "label": "mob_inv",
            "name": "Mob Inv",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms/mob_inv"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/forms"
                }
            ]
        },
        {
            "label": "hi_inv",
            "name": "Hi Inv",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms/hi_inv"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/forms"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms?limit=2&offset=2"
        },
        {
            "rel": "prev",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms?limit=2&offset=0"
        },
        {
            "rel": "next",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/forms?limit=2&offset=4"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/forms"
        }
    ]
}