REST API for Oracle Fusion Field Service Cloud Service

Create or replace an activity type group

put

/rest/ofscMetadata/v1/activityTypeGroups/{label}

This operation creates an activity type group resource or updates an existing one.

If the 'translation' parameter is not available for the update, then the translations are not changed; else all the translations are replaced by the structure from the request. The translations that are sent as entity fields are ignored.

Request

Path Parameters

label(required): string

Minimum Length: 1

Maximum Length: 40

The label of the activity type group.

This section describes the request body parameters for this operation.

Root Schema : Activity Type Group

Type: object

Title: Activity Type Group

The object representing group activity types.

Show Source

label: string

Title: Label

Minimum Length: 1

Maximum Length: 32

The label of the activity type group.
translations: array Translations

Title: Translations

The array of translation objects associated with the activity type group.

{
    "type":"object",
    "title":"Activity Type Group",
    "description":"The object representing group activity types.",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":32,
            "title":"Label",
            "description":"The label of the activity type group."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The array of translation objects associated with the activity type group."
        }
    }
}

Nested Schema : Translations

Type: array

Title: Translations

The array of translation objects associated with the activity type group.

Show Source

Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"The array of translation objects associated with the activity type group."
}

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

Response

Supported Media Types

application/json
application/schema+json

200 Response

This section describes the 200 status response for this operation. This code is returned when an activity type group object is updated.

Root Schema : ActivityTypeGroup

Type: object

Show Source

activityTypes: array Activity Types

Title: Activity Types

The array of activity type objects associated with the activity type group.

{
    "allOf":[
        {
            "$ref":"#/definitions/ActivityTypeGroupForPut"
        }
    ],
    "properties":{
        "activityTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The label of the activity type object.",
                        "type":"string"
                    }
                },
                "required":[
                    "label"
                ]
            },
            "title":"Activity Types",
            "description":"The array of activity type objects associated with the activity type group."
        }
    }
}

Match All

Show Source

object Activity Type Group

Title: Activity Type Group

The object representing group activity types.

{
    "allOf":[
        {
            "$ref":"#/definitions/ActivityTypeGroupForPut"
        }
    ],
    "properties":{
        "activityTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The label of the activity type object.",
                        "type":"string"
                    }
                },
                "required":[
                    "label"
                ]
            },
            "title":"Activity Types",
            "description":"The array of activity type objects associated with the activity type group."
        }
    }
}

Nested Schema : Activity Types

Type: array

Title: Activity Types

The array of activity type objects associated with the activity type group.

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"The label of the activity type object.",
                "type":"string"
            }
        },
        "required":[
            "label"
        ]
    },
    "title":"Activity Types",
    "description":"The array of activity type objects associated with the activity type group."
}

Nested Schema : Activity Type Group

Type: object

Title: Activity Type Group

The object representing group activity types.

Show Source

label: string

Title: Label

Minimum Length: 1

Maximum Length: 32

The label of the activity type group.
translations: array Translations

Title: Translations

The array of translation objects associated with the activity type group.

{
    "type":"object",
    "title":"Activity Type Group",
    "description":"The object representing group activity types.",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":32,
            "title":"Label",
            "description":"The label of the activity type group."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The array of translation objects associated with the activity type group."
        }
    }
}

Nested Schema : items

Type: object

Show Source

label(required): string

The label of the activity type object.

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the activity type object.",
            "type":"string"
        }
    },
    "required":[
        "label"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The array of translation objects associated with the activity type group.

Show Source

Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"The array of translation objects associated with the activity type group."
}

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

201 Response

This section describes the 201 status response for this operation. This code is returned when an activity type group object is created.

Root Schema : ActivityTypeGroup

Type: object

Show Source

activityTypes: array Activity Types

Title: Activity Types

The array of activity type objects associated with the activity type group.

{
    "allOf":[
        {
            "$ref":"#/definitions/ActivityTypeGroupForPut"
        }
    ],
    "properties":{
        "activityTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The label of the activity type object.",
                        "type":"string"
                    }
                },
                "required":[
                    "label"
                ]
            },
            "title":"Activity Types",
            "description":"The array of activity type objects associated with the activity type group."
        }
    }
}

Match All

Show Source

object Activity Type Group

Title: Activity Type Group

The object representing group activity types.

{
    "allOf":[
        {
            "$ref":"#/definitions/ActivityTypeGroupForPut"
        }
    ],
    "properties":{
        "activityTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The label of the activity type object.",
                        "type":"string"
                    }
                },
                "required":[
                    "label"
                ]
            },
            "title":"Activity Types",
            "description":"The array of activity type objects associated with the activity type group."
        }
    }
}

Nested Schema : Activity Types

Type: array

Title: Activity Types

The array of activity type objects associated with the activity type group.

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"The label of the activity type object.",
                "type":"string"
            }
        },
        "required":[
            "label"
        ]
    },
    "title":"Activity Types",
    "description":"The array of activity type objects associated with the activity type group."
}

Nested Schema : Activity Type Group

Type: object

Title: Activity Type Group

The object representing group activity types.

Show Source

label: string

Title: Label

Minimum Length: 1

Maximum Length: 32

The label of the activity type group.
translations: array Translations

Title: Translations

The array of translation objects associated with the activity type group.

{
    "type":"object",
    "title":"Activity Type Group",
    "description":"The object representing group activity types.",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":32,
            "title":"Label",
            "description":"The label of the activity type group."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The array of translation objects associated with the activity type group."
        }
    }
}

Nested Schema : items

Type: object

Show Source

label(required): string

The label of the activity type object.

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the activity type object.",
            "type":"string"
        }
    },
    "required":[
        "label"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The array of translation objects associated with the activity type group.

Show Source

Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"The array of translation objects associated with the activity type group."
}

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.

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

Examples

The following example shows how to create/replace an activity type group by submitting a PUT request on the REST resource using cURL:

cURL command Example

The following shows an example of the cURL command.

curl -u 'clientId@instance:clientSecret' \
 -X PUT \
 --url https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/activityTypeGroups/mnt \
 --data-binary '{
    "translations":[
       {
          "language":"en",
          "name":"Maintenance"
       },
       {
           "language":"es",
           "name":"mantenimiento"
       }
    ]
}
'

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx
Date: Mon, 14 Oct 2019 10:48:34 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.

{
    "label": "mnt",
    "name": "Maintenance",
    "translations": [
        {
            "language": "en",
            "name": "Maintenance",
            "languageISO": "en-US"
        },
        {
            "language": "es",
            "name": "mantenimiento",
            "languageISO": "es-ES"
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/activityTypeGroups/mnt"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/activityTypeGroups"
        }
    ]
}