RestApiCategories.platformAdministration.desc

platform_administration

2025.08

2025.09

2025.10

2025.11

2025.12

This List Data API enables users to manage lookup lists across products and solutions.

List Data

2025.03

2024.09

2024.03

Checks for the existence of a running job that is associated with a list.

A successful response (for example, 200 OK) indicates that a job is executing for the list. An unsuccessful response (for example, 404 Not Found) indicates that there are no jobs executing for the list.


listId

The media type for the body of the request or response.

Content-Type

Here is an example of an error response when the user did not have the necessary permissions.

This schema defines the representation of an error with additional errors.

Error

The user did not have the necessary permissions.

Here is an example of an error response when no item exists at the requested path.

Here is an example of an error response when the request could not be fulfilled because of an unexpected server error.

The request could not be fulfilled because of an unexpected server error.

Check that a list has a running job

This schema defines the list of top-level resources that are available from the root of the API.

This schema identifies the column information objects that define the properties for a list.

Column Information

This schema defines the data mask for a column's value when retrieving a list's contents.

Data Mask

This schema defines the common error properties.

Error Common

This schema defines the representation of an error.

Error Item

This schema defines the representation of an error without another level of errors.

Error Single Level

This schema defines the import job that loads a list's contents from a data file.

Import Job

This schema defines the job representation properties.

Job Representation

This schema defines a link to a related operation or resource.

Link

This schema defines the list consumer details.

List Consumers

"This schema defines the object that contains the metadata for a list's columns and content records that are stored in an array of rows."


List Data Set

"This schema defines the object that contains a collection of row values and metadata."


List Data Set Details

List Data Set Details Version One

List Details

This schema defines the details of the first version of a list.

List Details Version One

This schema defines the list details with consumers.

List Details with Consumers

This schema defines the details with consumers of the first version of a list.

List Details with Consumers Version One

List Properties

This schema defines the properties of the first version of a list.

List Properties Version One

This schema describes a collection of list resources.

List Resource Collection

List Resource Consumer List

This schema describes a collection of list resource revisions.

List Resource Revision Collection

This schema defines the list revision properties.

List Revision

This schema defines the membership queries from a client.

Membership Query Collection

This schema defines the membership results from a client.

Membership Result Collection

This schema defines the resource that contains information about an asynchronous job that removes a list's contents.

Purge Job

This schema defines a paginated collection of resources.

Resource Collection

This schema defines the summary details of a list that is required by the Catalog service.

Summary Details

This schema defines the transfer object schema that is required by the Transfer service.

Transfer Object

This schema defines the resource that contains information about an asynchronous job that updates the state of each row in a list.

Status	Meaning	Description
200	OK	The request succeeded.	Headers
403	Forbidden	The user did not have the necessary permissions.		Schema
404	Not Found	No item exists at the requested path.		Schema
500	Internal Server Error	The request could not be fulfilled because of an unexpected server error.		Schema

Check that a list has a running job

Request Samples

Response Samples

Path Parameters

Responses