Retrieve attribute metadata for case resource

Overview

Use this API to retrieve the metadata for custom attributes of a case 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

Examples:
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 to return

  • Applicable when no custom attributes are configured for the case resource.
400

Bad Request message

401

Unauthorized

406

Not Acceptable

500

Internal server error

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

  • GET /core/casemgr/v3/case/attributes?$attribute=custom
    • 

  • This example demonstrates the following:
      

    • Getting the metadata for custom attributes of case resource.
      • 

    

    • 



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