List Management Term Lists - Get Details
Returns list ID details of the term list with listId equal to the passed list ID.
GET {Endpoint}/contentmoderator/lists/v1.0/termlists/{listId}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Supported Azure Cognitive Services endpoints (protocol and host name, such as https://westus.api.cognitive.microsoft.com). |
list
|
path | True |
string |
List ID of the image list. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
Error response. |
Security
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Examples
Get Term ListId Details request
Sample Request
GET {Endpoint}/contentmoderator/lists/v1.0/termlists/89003
Sample Response
{
"Id": 89003,
"Name": "TermList A",
"Description": "sample string 3",
"Metadata": {
"Sample string 1": "sample string 2",
"Sample string 3": "sample string 4"
}
}
Definitions
Name | Description |
---|---|
APIError |
Error information that the API returns. |
Error |
Error body. |
Term |
Term list properties. |
APIError
Error information that the API returns.
Name | Type | Description |
---|---|---|
Error |
Error body. |
Error
Error body.
Name | Type | Description |
---|---|---|
Code |
string |
|
Message |
string |
TermList
Term list properties.
Name | Type | Description |
---|---|---|
Description |
string |
Description for the term list. |
Id |
integer |
Term list ID. |
Metadata |
object |
Term list metadata. |
Name |
string |
Term list name. |