Get an activity type group

get

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

This operation retrieves the details of the specified activity type group.

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

Request

Path Parameters
  • Minimum Length: 1
    Maximum Length: 40
    The label of the activity type group.
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
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 get an activity type group by submitting a GET request on the REST resource.

cURL Command Example

The following shows an example of the cURL command.

curl -X GET "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/activityTypeGroups/customer" -u "<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>" -H "Accept: application/json" -H "Content-Type: application/json"

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:53:17 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": "customer",
    "name": "Customer",
    "activityTypes": [
        {
            "label": "4"
        },
        {
            "label": "5"
        },
        {
            "label": "6"
        },
        {
            "label": "7"
        },
        {
            "label": "8"
        },
        {
            "label": "installation"
        },
        {
            "label": "Testing"
        },
        {
            "label": "Multiday"
        },
        {
            "label": "SDI"
        }
    ],
    "translations": [
         {
            "language": "en",
            "name": "Customer",
            "languageISO": "en-US"
        },
        {
            "language": "es",
            "name": "Cliente",
            "languageISO": "es-ES"
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/activityTypeGroups/customer"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/activityTypeGroups"
        }
    ]
}
Back to Top