Jump to

• Request
• Response
• Examples

Update or replace enumeration values of a property

put

/rest/ofscMetadata/v1/properties/{label}/enumerationList

This operation updates or replaces the enumeration values of the specified property.

The operation is applicable only for properties of type 'enumeration'.

Consider the following while updating the enumeration values of a property:

• The specified property must exist in Oracle Field Service.
• The enumeration values cannot be deleted.
• The property 'country_code' cannot be updated using this operation, though the property is of type enumeration.
• The field 'label' cannot be set to '-1' or '0'.
• The English translation for each enumeration value is required and cannot be cleared.
• API doesn't allow to set "inactive" status for all items, at least one item should remain active.

Request

Path Parameters

• label(required): string
  Minimum Length: 1

  Maximum Length: 40

  The label of the property.

Body ()

The property enumerations object that needs to be updated.

Root Schema : schema

Type: array

Show Source

• Array of: array Items
  Title: Items

  An array of enumeration values.

  Note: At least one item in the array should be active.

{
    "items":{
        "title":"Items",
        "type":"array",
        "description":"An array of enumeration values.</p><p><b>Note</b>: At least one item in the array should be active.</p>",
        "items":{
            "$ref":"#/definitions/PropertyEnumeration"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

An array of enumeration values.

Note: At least one item in the array should be active.

Show Source

• Array of: object Property Enumeration
  Title: Property Enumeration

{
    "title":"Items",
    "type":"array",
    "description":"An array of enumeration values.</p><p><b>Note</b>: At least one item in the array should be active.</p>",
    "items":{
        "$ref":"#/definitions/PropertyEnumeration"
    }
}

Nested Schema : Property Enumeration

Type: object

Title: Property Enumeration

Show Source

• active: boolean
  Title: Active

  Contains one of the following values: true or false. If true, then the enumeration item is active. If false, then then the enumeration item is inactive.
• label(required): string
  Title: Label

  Minimum Length: 1

  Maximum Length: 255

  The code of the enumeration item. This code is unique only to the specified property. The values '0' and '-1' are reserved for internal purposes and cannot be used. The values cannot be changed or deleted.
• translations(required): array Translations
  Title: Translations

  An array containing the translations of the enumeration item in different languages.

{
    "type":"object",
    "title":"Property Enumeration",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "title":"Label",
            "description":"The code of the enumeration item. This code is unique only to the specified property. The values '0' and '-1' are reserved for internal purposes and cannot be used. The values cannot be changed or deleted."
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false. If true, then the enumeration item is active. If false, then then the enumeration item is inactive. "
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"An array containing the translations of the enumeration item in different languages."
        }
    },
    "required":[
        "label",
        "translations"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

An array containing the translations of the enumeration item in different languages.

Show Source

• Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"An array containing the translations of the enumeration item in different languages."
}

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"
    ]
}

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 : Property Enumeration

Type: object

Title: Property Enumeration

Show Source

• active: boolean
  Title: Active

  Contains one of the following values: true or false. If true, then the enumeration item is active. If false, then then the enumeration item is inactive.
• label(required): string
  Title: Label

  Minimum Length: 1

  Maximum Length: 255

  The code of the enumeration item. This code is unique only to the specified property. The values '0' and '-1' are reserved for internal purposes and cannot be used. The values cannot be changed or deleted.
• translations(required): array Translations
  Title: Translations

  An array containing the translations of the enumeration item in different languages.

{
    "type":"object",
    "title":"Property Enumeration",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "title":"Label",
            "description":"The code of the enumeration item. This code is unique only to the specified property. The values '0' and '-1' are reserved for internal purposes and cannot be used. The values cannot be changed or deleted."
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false. If true, then the enumeration item is active. If false, then then the enumeration item is inactive. "
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"An array containing the translations of the enumeration item in different languages."
        }
    },
    "required":[
        "label",
        "translations"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

An array containing the translations of the enumeration item in different languages.

Show Source

• Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"An array containing the translations of the enumeration item in different languages."
}

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 or replace the enumeration of property's by submitting a PUT request on the REST resource.

Example of Request Header

The following shows an example of the request header.

curl -u 'clientId@instanceName:clientSecret' \
-X PUT \
--url 'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/properties/someEnumPropertyLabel/enumerationList' \
-d '{
    "items": [
        {
            "label": "code1",
            "active": true,
            "translations": [
                {
                    "language": "en",
                    "name": "Code 1"
                }
            ]
        },
        {
            "label": "code2",
            "active": true,
            "translations": [
                {
                    "language": "en",
                    "name": "Code 2"
                }
            ]
        }
    ]
}'

Example of Response Body

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

HTTP/1.1 200 OK

{
    "items": [
        {
            "label": "code1",
            "active": true,
            "translations": [
                {
                    "language": "en",
                    "name": "Code 1"
                }
            ]
        },
        {
            "label": "code2",
            "active": true,
            "translations": [
                {
                    "language": "en",
                    "name": "Code 2"
                }
            ]
        }
    ]
}

Back to Top