List Management Term Lists - Refresh Index

Reference

Service:: Cognitive Services

API Version:: 1.0

Refreshes the index of the list with listId equal to the passed list ID.

POST {Endpoint}/contentmoderator/lists/v1.0/termlists/{listId}/RefreshIndex?language={language}

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).
listId	path	True	string	List ID of the image list.
language	query	True	string	Language of the terms.

Request Header

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

Responses

Name	Type	Description
200 OK	RefreshIndex	OK.
Other Status Codes	APIError	Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Refresh Term Index request

Sample request

HTTP

POST {Endpoint}/contentmoderator/lists/v1.0/termlists/89003/RefreshIndex?language=eng

Sample response

Status code:: 200

{
  "ContentSourceId": "89003",
  "IsUpdateSuccess": true,
  "AdvancedInfo": [],
  "Status": {
    "Code": 3000,
    "Description": "RefreshIndex successfully completed.",
    "Exception": ""
  },
  "TrackingId": "WE_7be12265b82742749e6b6b1b0_ContentModerator.Preview_e220d7be-49d0-4553-94f6-fa5ad4ae488e"
}

Definitions

Name	Description
APIError	Error information that the API returns.
Error	Error body.
RefreshIndex	Response after you refresh the index.
Status	Status 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

RefreshIndex

Response after you refresh the index.

Name	Type	Description
AdvancedInfo	object[]	Advanced info list.
ContentSourceId	string	Content source ID.
IsUpdateSuccess	boolean	Update success status.
Status	Status	Status of refreshing the index.
TrackingId	string	Tracking ID.

Status

Status properties.

Name	Type	Description
Code	integer	Status code.
Description	string	Status description.
Exception	string	Exception status.

Share via