Developer Portal
Last Updated: February 19, 2016
Creating a new category metadata
The API provides to create a new category metadata.
Request
{
"Key":"41b104b9-5805-4d73-b596-6ad08dfa3684",
"Value":"bb2f9519-1949-425a-8719-4536dfee856b",
"CategoryId":1,
}
| HTTP Method | Resource URI |
|---|---|
| POST | https://{tenantName}.api.xomni.com/private/catalog/categorymetadata |
Request Body Description
| Parameter Name | Description | Type | Conditions |
|---|---|---|---|
| CategoryId | The unique ID of the category. | Number |
Required
|
| Key | The key value of the metadata. | String |
Required
|
| Value | The value of the metadata. | String |
Required
|
Request Headers
| Header Field Name | Description |
|---|---|
| Content-Type |
Content type of the response entity. The value of this header is always application/json.
|
| Accept |
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
|
| Authorization |
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
|
Response
{
"Key":"41b104b9-5805-4d73-b596-6ad08dfa3684",
"Value":"bb2f9519-1949-425a-8719-4536dfee856b",
"CategoryId":1,
}
Response Body Description
| Parameter Name | Description | Type |
|---|---|---|
| CategoryId | The unique ID of the category. | Number |
| Key | The key value of the metadata. | String |
| Value | The value of the metadata. | String |
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 POST operations. Possible response status codes are as listed below:
| Status Code | Description |
|---|---|
| 404 (Not Found) | Category not found. |
| 409 (Conflict) | Given category metadata already exists. |