List Management Term Lists - Get All Term Lists

  • Reference
Service:
Cognitive Services
API Version:
1.0

Gets all the term lists.

GET {Endpoint}/contentmoderator/lists/v1.0/termlists

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).

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Responses

Name Type Description
200 OK

TermList[]

OK.
Other Status Codes

APIError

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Get All Termlists request

Sample request

GET {Endpoint}/contentmoderator/lists/v1.0/termlists

Sample response

Status code:
200 
[
  {
    "Id": 99083,
    "Name": "RacyContentList",
    "Description": "List of racy terms.",
    "Metadata": {
      "Contentsource": "content source A",
      "Purpose": "task A"
    }
  },
  {
    "Id": 89117,
    "Name": "AbuseContentList",
    "Description": "List of abusive terms.",
    "Metadata": {
      "Contentsource": "content source B",
      "TaggedAs": "abuse"
    }
  }
]

Definitions

Name Description
APIError

Error information that the API returns.
Error

Error body.
TermList

Term list properties.

APIError

Error information that the API returns.

Name Type Description
Error

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.