RestApiCategories.platformAdministration.desc

platform_administration

2024.10

2024.11

2024.12

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

List Data

2024.08

2024.09

2024.03

A universally unique identifier for a list.

listId

A universally unique identifier for a list revision.

revisionId

Here is an example of a response to a request to get a list revision.

This schema defines the list revision properties.

List Revision

Here is an example of an error response when the request was invalid.

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

Error

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

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.

Get a list revision

This schema defines a paginated collection of resources.

Resource Collection

This schema defines the list version one properties.

List Properties Version One

List Properties

This schema describes a collection of list resources.

List Resource Collection

List Details

This schema defines the list consumer details.

List Consumers

This schema defines the list details with consumers

List Details with Consumers

List Resource Consumer List

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 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 import job that loads a list's contents from a data file.

Import Job

"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 Version One

List Data Set Details

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

Purge Job

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

Update Content State Job

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 a link to a related operation or resource.

Link

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

This schema describes a collection of list resource revisions.

Name	Type	Required	Description
listId	string	true	A universally unique identifier for a list. Examples: "3659ea38-2618-4474-aeac-0bf6cfd3c322"
revisionId	string	true	A universally unique identifier for a list revision. Examples: "9b967566-6dcb-427f-93b3-8b9be1a945c9"

Status	Meaning	Description
200	OK	The request succeeded.	Schema
400	Bad Request	The request was invalid.	Schema
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

Get a list revision

Request Samples

Response Samples

Path Parameters

Responses