Developer Portal
Last Updated: May 05, 2016
Fetching document assets metadata
This API allows a client application to retrieve a list of key/value metadata pairs for a particular document asset. The metadata may be used to store contextual and optional data about a document.
Request
| HTTP Method | Resource URI |
|---|---|
| GET | https://{tenantName}.api.xomni.com/catalog/documentmetadata?assetId={assetId} |
URI Parameters
| Parameter Name | Description | Type | Conditions |
|---|---|---|---|
| assetId | The unique ID of the asset. | Number |
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
{
"Data": [
{
"Key": "documentmetadatakey0",
"Value": "documentmetadatavalue0"
},
{
"Key": "documentmetadatakey1",
"Value": "documentmetadatavalue1"
}
]
}
Response Body Description
| Parameter Name | Description | Type |
|---|---|---|
| Data[0..N].Key | The key for the metadata. | String |
| Data[0..N].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 GET operations. Possible response status codes are as listed below:
| Status Code | Description |
|---|---|
| 404 (Not Found) | Asset or related metadata could not be found. |