Jump to

• Request
• Response
• Examples

Get languages

get

/rest/ofscMetadata/v1/languages

This operation retrieves a collection of languages.

The response contains the translations of the user's language in the translation structure and in the entity fields.

Request

Query Parameters

• limit: integer
  The number of languages 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.

Back to Top

Response

Supported Media Types

• application/json
• application/schema+json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : Languages

Type: object

The collection of languages.

Show Source

• items: array items
• limit: integer
  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
  The offset value specified in the request.
• totalResults: integer
  The total number of language records in the collection.

{
    "description":"The collection of languages.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Language"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of language records in the collection."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value specified in the request."
        },
        "limit":{
            "type":"integer",
            "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

Show Source

• Array of: object Languages
  Title: Languages

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

Nested Schema : Languages

Type: object

Title: Languages

Show Source

• active(required): boolean
  Title: Active

  Contains one of the following values: true or false.

  • If true, then the activity type is listed as a possible value in the 'Activity Type' drop-down list in the Manage or Mobility apps while creating an activity.
  • If false, then the activity type is not listed as a value in the drop-down list.

  The default value is true.

• label(required): string
  Title: Label

  The unique label assigned to the language code. For example, en.
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 40

  The translation for the language name. If the language parameter is specified, then the name is provided in that language.

  If the language parameter is not specified, then the name is provided in English, unless the request is performed using an Oracle Field Service user account which is linked to an API application (in this case, the name is provided in the language of the user making the request).

• translations(required): array Translations
  Title: Translations

  The array of associated translations.

{
    "type":"object",
    "title":"Languages",
    "properties":{
        "label":{
            "type":"string",
            "title":"Label",
            "description":"The unique label assigned to the language code. For example, en."
        },
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":40,
            "title":"Name",
            "description":"The translation for the language name. If the language parameter is specified, then the name is provided in that language.<p>If the language parameter is not specified, then the name is provided in English, unless the request is performed using an Oracle Field Service user account which is linked to an API application (in this case, the name is provided in the language of the user making the request).</p>"
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false.<ul><li>If true, then the activity type is listed as a possible value in the 'Activity Type' drop-down list in the Manage or Mobility apps while creating an activity.</li><li>If false, then the activity type is not listed as a value in the drop-down list.</li></ul><p>The default value is true.</p>"
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The array of associated translations."
        }
    },
    "required":[
        "label",
        "name",
        "active",
        "translations"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The array of associated translations.

Show Source

• Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"The array of associated translations."
}

Nested Schema : Translation

Type: object

Show Source

• language(required): string
  The language code of the translated text. The code in the response is two characters long (for example, 'en', 'es').

  See Supported Language Codes to view the values that are supported.

• languageISO: string
  The ISO language code (for example, 'en-US').
• name(required): string
  The specified name of the property translated to the language code available in the system.

{
    "properties":{
        "language":{
            "description":"The language code of the translated text. The code in the response is two characters long (for example, 'en', 'es').<p>See <a href='OFSC_Supported_Language_Codes.html'>Supported Language Codes</a> to view the values that are supported.</p> ",
            "type":"string"
        },
        "languageISO":{
            "description":"The ISO language code (for example, 'en-US').",
            "type":"string"
        },
        "name":{
            "description":"The specified name of the property translated to the language code available in the system.",
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Error response

Show Source

• detail: string
  The detailed information about the error.
• status: string
  The HTTP status code.
• title: string
  The summary of the error message.
• type: string
  The URL of the page containing the error details.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the page containing the error details."
        },
        "title":{
            "type":"string",
            "description":"The summary of the error message."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code."
        },
        "detail":{
            "type":"string",
            "description":"The detailed information about the error."
        }
    },
    "description":"Error response"
}

Back to Top

Examples

The following example shows how to update a property by submitting a PATCH request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET /rest/ofscMetadata/v1/languages?limit=20&offset=1 HTTP/1.1
Host: <instance_name>.fs.ocs.oraclecloud.com
Authorization: Basic c29hcEBwZXRyb2xpYXNoZXZ5Y2gucmVzdDox
Accept: */*

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.6.3
Date: Wed, 16 Sep 2015 15:32:19 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Example of Response Body

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

{
    "totalResults":18,
    "limit":20,
    "offset":1,
    "items":[
        {
            "label":"el",
            "name":"Greek",
            "active":"true"
            },
            "translations":[
                {
                    "language":"en",
                    "name":"Greek"
                },
                {..}
            ]
        },
        {
            "label":"en",
            "name":"English",
            "active":"true"
            },
            "translations":[
                {
                    "language":"en",
                    "name":"English"
                },
                {..}
            ]
        },
       {...}
    ]
}

Back to Top