Retrieve attribute metadata for activity resource

Overview

Use this API to retrieve attribute meta data for activity resource.

SecurityoAuthUser or oAuthClient
Request
query Parameters
$attribute
required
string

Server can be prompted to return additional attributes of resource representation using $attribute common query parameter.

Available values: all, custom, type, language

  • type: Information about activity types and subtypes is returned. This is currently limited to social, calltrack and task types and their subtypes.
  • language: Languages supported by the activity is returned.
  • custom: Custom attributes, if any, is returned.
  • all: Activity types and subtypes, language and custom attributes are returned.

At least one of these values must be provided for $attribute.

Examples:
$attribute=
Attributes 'custom' is returned in server response.
$attribute=custom
All the attributes are returned in server response.
$attribute=all
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

204

No content

400

Bad Request message

401

Unauthorized

403

Forbidden

406

Not Acceptable

500

Internal server error

get/activity/attributes
Request samples
Response samples
application/json
    

  • GET /core/casemgr/v3/activity/attributes?$attribute=type
    • 

  • This example demonstrates the following:
      

    • Getting metadata for a single attribute. This example retrieves the details of the "type" attribute of the activity resource.
      • 

    

    • 



{
  • "attribute": [
    ],
  • "resource": "activity"
}