List Management Image Lists - Get Details

  • Reference
Service:
Cognitive Services
API Version:
1.0

Returns the details of the image list with listId equal to the passed list ID.

GET {Endpoint}/contentmoderator/lists/v1.0/imagelists/{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).
listId
 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

ImageList

OK.
Other Status Codes

APIError

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Get List Id Details request

Sample request

GET {Endpoint}/contentmoderator/lists/v1.0/imagelists/123

Sample response

Status code:
200 
{
  "Id": 94557,
  "Name": "ImageList 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.
ImageList

Image 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

ImageList

Image list properties.

Name Type Description
Description

string

Description for the image list.
Id

integer

Image list ID.
Metadata

object

Image list metadata.
Name

string

Image list name.