Detailed Description

Get Case Attributes

Overview

This API allows retrieving the metadata for custom attributes of case resource.

Since: 11.6

APIs

Method	URL	Description
GET	`/ws/v12/interaction/case/attributes`	Retrieve attribute metadata for case resource.

Authentication

Authentication is required. The client must be logged in to call this API. Each API request must contain X-egain-session request header returned by Login API.

Permissions

No permissions are required.

Licenses

The logged in user must have the following licenses:

Any User Licenses

Request

Request headers

Name	Description	Allowed values	Default value
X-egain-session	Session ID obtained from Login API response header	N/A	N/A
Accept	Content type accepted by client	`application/xml` or `application/json`	N/A
Accept-Language	Language locale accepted by client (used for locale specific fields in resource representation and in error responses)	Supported 'Accept-Language' header codes	`default system language`

Supported API specific query parameters

None.

Supported common query parameters

$attribute: Must be provided to get metadata for case attributes. Refer to Supported Common Query Parameters in ECE REST API for details.

The value of $attribute must be "custom".

Response

Response headers

Name	Description	Possible values
X-egain-session	Session ID of the current user session	N/A
Content-Type	Media type of response body	`application/xml` or `application/json`

Response body

The response body can be in either XML or JSON format.

Response body XML schemas:

schema-common-Attributes - used in case of success
schema-kb-WSError - used in case of error

HTTP status codes

Success Status codes

200 - OK

The request executed successfully.

204 - No content

No content to return. Applicable when no custom attributes are configured for the case resource.

Failure Status codes

400 - Bad Request

Unsupported query parameter is sent in request URL.
Required common query parameter is not provided. Refer Supported common query parameters section for more details.

401 - Unauthorized

X-egain-session request header is missing.
Session is invalid or expired.

406 - Not Acceptable

Invalid 'Accept-Language' header value.

500 - Internal server error

Examples:

Example 1 - Get the metadata for custom attributes