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
  • Minimum Length: 1
    Maximum Length: 40
    The label of the activity type group.
Body ()
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
Nested Schema : Translations
Type: array
Title: Translations
The array of translation objects associated with the activity type group.
Show Source
Nested Schema : Translation
Type: object
Show Source
  • 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.
  • 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)
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation. This code is returned when an activity type group object is updated.
Body ()
Root Schema : ActivityTypeGroup
Type: object
Show Source
Match All
Show Source
Nested Schema : Activity Types
Type: array
Title: Activity Types
The array of activity type objects associated with the activity type group.
Show Source
Nested Schema : Activity Type Group
Type: object
Title: Activity Type Group
The object representing group activity types.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : Translations
Type: array
Title: Translations
The array of translation objects associated with the activity type group.
Show Source
Nested Schema : Translation
Type: object
Show Source
  • 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.
  • 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)

201 Response

This section describes the 201 status response for this operation. This code is returned when an activity type group object is created.
Body ()
Root Schema : ActivityTypeGroup
Type: object
Show Source
Match All
Show Source
Nested Schema : Activity Types
Type: array
Title: Activity Types
The array of activity type objects associated with the activity type group.
Show Source
Nested Schema : Activity Type Group
Type: object
Title: Activity Type Group
The object representing group activity types.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : Translations
Type: array
Title: Translations
The array of translation objects associated with the activity type group.
Show Source
Nested Schema : Translation
Type: object
Show Source
  • 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.
  • 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)

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

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>.etadirect.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>.etadirect.com/rest/ofscMetadata/v1/activityTypeGroups/mnt"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/activityTypeGroups"
        }
    ]
}
Back to Top