Detailed Description

Examples for Retrieve Case Attribute Metadata

Example 1 - Get the metadata for custom attributes

This example demonstrates the following:

Getting the metadata for custom attributes of case resource.

XML

Request

Method	URL
GET	`/ws/v12/interaction/case/attributes?$attribute=custom`

Request headers

Name	Values
X-egain-session	valid session ID
Accept	`application/xml`
Accept-Language	`en-US`

Response:
HTTP/1.1 200 OK

Response headers

Name	Values
X-egain-session	current session ID
Content-Type	`application/xml`

Response body

<?xml version="1.0" encoding="UTF-8"?>
<attributes xmlns="http://bindings.egain.com/ws/model/v12/gen/common/attribute" resource="case">
    <attribute name="duration" custom="true">
        <dataSize>9</dataSize>
        <dataType>integer</dataType>
    </attribute>
    <attribute name="priorcaselist" custom="true">
        <dataSize>1024</dataSize>
        <dataType>string</dataType>
    </attribute>
    <attribute name="issuetype" custom="true">
        <dataSize>255</dataSize>
        <dataType>stringList</dataType>
        <options isMultiSelect="false">
            <option>
                <value>1</value>
                <displayValue>Electrical</displayValue>
            </option>
            <option isDefault="true">
                <value>2</value>
                <displayValue>Mechanical</displayValue>
            </option>
            <option>
                <value>3</value>
                <displayValue>Body</displayValue>
            </option>
        </options>
    </attribute>
</attributes>

JSON

Request

Method	URL
GET	`/ws/v12/interaction/case/attributes?$attribute=custom`

Request headers

Name	Values
X-egain-session	valid session ID
Accept	`application/json`
Accept-Language	`en-US`

Response:
HTTP/1.1 200 OK

Response headers

Name	Values
X-egain-session	current session ID
Content-Type	`application/json`

Response body

{
    "attribute": [
        {
            "dataSize": 9,
            "dataType": "integer",
            "name": "duration",
            "custom": true
        },
        {
            "dataSize": 1024,
            "dataType": "string",
            "name": "priorcaselist",
            "custom": true
        },
        {
            "dataSize": 255,
            "dataType": "stringList",
            "options": {
                "option": [
                    {
                        "value": "1",
                        "displayValue": "Electrical"
                    },
                    {
                        "value": "2",
                        "displayValue": "Mechanical",
                        "isDefault": true
                    },
                    {
                        "value": "3",
                        "displayValue": "Body"
                    }
                ],
                "isMultiSelect": false
            },
            "name": "issuetype",
            "custom": true
        }
    ],
    "resource": "case"
}