Jump to

• Request
• Response
• Examples

Get activity type groups

get

/rest/ofscMetadata/v1/activityTypeGroups

This operation retrieves a collection of activity type groups.

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

Query Parameters

• limit: integer

  The number of activity type groups to be returned in the response. The minimum value that can be specified is 1. The maximum value that can be specified is 100. If the specified value is greater than 100, zero, or if no value is specified, then it defaults to 100.

• offset: integer

  The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.

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 : ActivityTypeGroups

Type: object

The collection of activity type groups.

Show Source

• items: array items
• limit: integer
  The limit value specified in the request.
• offset: integer
  The offset value specified in the request.
• totalResults: integer
  The total number of activity type groups in the collection.

{
    "description":"The collection of activity type groups.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ActivityTypeGroup"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of activity type groups in the collection."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value specified in the request."
        },
        "limit":{
            "type":"integer",
            "description":"The limit value specified in the request."
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ActivityTypeGroup

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ActivityTypeGroup"
    }
}

Nested 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.

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 get a collection of activity type groups 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" -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 11:06: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.

{
    "hasMore": false,
    "totalResults": 5,
    "limit": 100,
    "offset": 0,
    "items": [
        {
            "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"
                }
            ]
        },
        {
            "label": "internal",
            "name": "Internal",
            "activityTypes": [
                {
                    "label": "LU"
                },
                {
                    "label": "AS"
                },
                {
                    "label": "OF"
                },
                {
                    "label": "WH"
                },
                {
                    "label": "WZ"
                },
                {
                    "label": "VH"
                }
            ],
            "translations": [
                {
                    "language": "en",
                    "name": "Internal",
                    "languageISO": "en-US"
                },
                {
                    "language": "es",
                    "name": "Interno",
                    "languageISO": "es-ES"
                }
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/activityTypeGroups/internal"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/activityTypeGroups"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/activityTypeGroups?limit=100&offset=0"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/activityTypeGroups"
        }
    ]
}

Back to Top