XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides a way to partially update an existing dynamic attribute type in backend.

Request

{  
   "Id":3,
   "DataType":"String"
}
HTTP Method Resource URI
PATCH https://{tenantName}.api.xomni.com/private/catalog/dynamicattributetypes

Request Body Description

Parameter Name Description Type Conditions
Id Unique ID of a dynamic attribute type. Number
Mandatory.
Description Description of a dynamic attribute type. String
Optional.
Options Search options for a dynamic attribute type. See possible values section for detail. Number
Optional.
DataType Data type of the dynamic attribute type. See possible values section for detail. String
Optional.

Possible Values For "Options"

Value Description
0 Default Value – Not Initalized.
1 Retrievable.
2 Filterable.
4 Searchable.
8 Facetable.
16 Sortable.
Possible Values For "DataType"
Value
String
Boolean
Double
Integer
DateTimeOffset
GeographyPoint
GeographyPolygon

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

{  
   "Description":"Color",
   "Options":8,
   "Id":3,
   "DataType":"String"
}

Response Body Description

Parameter Name Description Type
Description Description of a dynamic attribute type. String
Options Search options for a dynamic attribute type. See possible values section for detail. Number
DataType Data type of the dynamic attribute type. See possible values section for detail. String
Id Unique ID of a dynamic attribute type. Number

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for PATCH operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) Invalid dynamic attribute type option.
404 (Not Found) Invalid dynamic attribute type description.
404 (Not Found) Dynamic attribute type not found.
409 (Conflict) Dynamic attribute type exists with the same description.