Get Metadata Template by ID.

Retrieve the metadata template and its attributes list by template ID

The user submitting the request to metadata template must have the Metadata Template Management security role privilege.

In response, it will contain the metadata groups template have and each group metadata attributes list.

SecurityApiKeyAuth or BasicAuth

Request

path Parameters

required

string

Specify a Metadata Template ID.

header Parameters

X-API-Key required	string Customer-specific API key required to invoke API.
Authorization required	string Provided by Authentication Token creation operation
AccessToken required	string JWT token provided by Authentication Token creation operation.
Content-Type required	string Value: "application/json"

Responses

200

The Response Body will be a JSON object representing the metadata template.

400

Wrong Template ID

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

get/metadata/template/{id}

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"template": {"metadataGroups": [{"groupOrder": 1,
"metadataGroupSearchField": "file_details",
"securityPermissions": [ ],
"metadataGroupName": "File Details",
"metadataAttributes": [{"name": "File Size",
"type": "text",
"length": 16,
"visible": true,
"readonly": false,
"required": false,
"facetable": true
},
{"name": "File Type",
"type": "controlledVocabulary",
"subType": "textBox",
"visible": true,
"readonly": false,
"required": false,
"facetable": true
}
]
},
{"groupOrder": 2,
"metadataSearchField": "document_details",
"securityPermissions": [ ],
"metadataGroupName": "Document Details",
"metadaAttributes": [{"name": "Document Owner",
"type": "controlledVocabulary",
"visible": true,
"readonly": false,
"required": false,
"facetable": true
}
]
},
{"groupOrder": 3,
"metadataSearchField": "categories",
"securityPermissions": [ ],
"metadataGroupName": "categories",
"metadataAttributes": [{"isSingleRow": false,
"visible": true,
"searchField": "categorie_table",
"tableFieldsDenormalized": [{"visible": true,
"readonly": false,
"searchField": "category_cascade",
"cascadeFieldsDenormalized": [{"isMultipleSelect": false,
"cascadeOrder": 0,
"visible": true,
"searchField": "category",
"type": "controlledVocabulary",
"required": false,
"controlledVocabularyId": "7d675ef0-f423-11e9-8071-89c0c4052141",
"readonly": false,
"name": "category",
"id": "725f7d71-9ab2-46b5-aea1-be03f47c9fe7",
"isRestricted": false
},
{"isMultipleSelect": false,
"cascadeOrder": 1,
"visible": true,
"searchField": "sub_category",
"type": "controlledVocabulary",
"required": false,
"controlledVocabularyId": "e0b96fb8-0f1e-46ec-9319-e78bdb127e3e",
"readonly": false,
"name": "Sub Category",
"facetable": true,
"id": "f33b5bc7-0c9e-4eba-aa4f-a1f502c0710c",
"isRestricted": false
}
],
"attributeOrder": 1,
"name": "Categories table",
"id": "4a515fea-e402-4331-b364-582b8ebf66c0",
"type": "tableAttribute",
"tableNameVisible": false
}
]
}
]
}
]
},
"templateId": "b7b4e518-b221-40ec-9051-3a9596883cf5",
"templateName": "Images",
"createdEpoch": 1588094144567,
"lastUpdatedEpoch": 1719233797847,
"templateType": ["asset"
]
}