Jump to

• Request
• Response
• Examples

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

• label(required): string
  Minimum Length: 1

  Maximum Length: 40

  The label of the activity type group.

Back to Top

Response

Supported Media Types

• application/schema+json
• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

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
  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.
• languageISO: string
  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)
• name(required): string

{
    "properties":{
        "language":{
            "description":"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.",
            "type":"string"
        },
        "languageISO":{
            "description":"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)",
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

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>.fs.ocs.oraclecloud.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>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/activityTypeGroups/customer"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/activityTypeGroups"
        }
    ]
}

Back to Top