List Management Image - Get All Image Ids

Service:

Azure AI Services

API Version:

1.0

Gets all image IDs from the list with listId equal to the passed list ID.

GET {Endpoint}/contentmoderator/lists/v1.0/imagelists/{listId}/images

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	ImageIds	OK.
Other Status Codes	APIError	Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Get All Image Ids request

Sample request

HTTP

GET {Endpoint}/contentmoderator/lists/v1.0/imagelists/89003/images

Sample response

Status code:

200

{
  "ContentSource": "79017",
  "ContentIds": [
    89207,
    89209,
    94162
  ],
  "Status": {
    "Code": 3000,
    "Description": "OK",
    "Exception": ""
  },
  "TrackingId": "WE_7be12265b8014274baea9219e6cg6b1b0_ContentModerator.Preview_5614wrl328-ba52-40b2-a220-16e55uha78a"
}

Definitions

Name	Description
APIError	Error information that the API returns.
Error	Error body.
ImageIds	Image ID properties.
Status	Status properties.

APIError

Object

Error information that the API returns.

Name	Type	Description
Error	Error	Error body.

Error

Object

Error body.

Name	Type	Description
Code	string
Message	string

ImageIds

Object

Image ID properties.

Name	Type	Description
ContentIds	integer[]	ID of the content.
ContentSource	string	Source of the content.
Status	Status	Get Image status.
TrackingId	string	Tracking ID.

Status

Object

Status properties.

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