List Data

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

List Definition

These endpoints are associated with a list's definition.
post
Create a list
Internal-Use OnlyCreates a new list definition.
/lists
get
Get a collection of lists
Internal-Use OnlyReturns a collection of lists.
/lists
head
Check that a list exists
Internal-Use OnlyChecks for the existence of a list.
/lists/{listId}
get
Get a list
Internal-Use OnlyReturns a list.
/lists/{listId}
put
Update a list's properties
Internal-Use OnlyUpdates a list's properties.
/lists/{listId}
delete
Delete a list
Internal-Use OnlyRemoves a list from the system.
/lists/{listId}
delete
Delete a list (privileged)
Internal-Use OnlyRemoves a list from the system.
/lists/{listId}/privilegedDelete
put
Update a list's properties (privileged)
Internal-Use OnlyUpdates a list's properties by a user who has privileged authorization.
/lists/{listId}/privilegedEdit
get
Get a collection of lists from the specified folder
Internal-Use OnlyReturns a collection of lists from the specified folder. This collection is paginated. A maximum of 1000 lists can be displayed.
/folders/{folderId}/lists

List State and Contents

These endpoints are associated with a list's state and contents.
get
Get the state of a list
Internal-Use OnlyReturns a value of 'deployed' or 'developing' for the list's 'state' property. A deployed list cannot be deleted.
/lists/{listId}/state
put
Update the state of a list
Internal-Use OnlyUpdates the list's 'state' property value as either 'deployed' or 'developing'.
/lists/{listId}/state
head
Check that a list has contents
Internal-Use OnlyChecks the existence of a list's contents.
/lists/{listId}/contents
get
Get a list's contents
Internal-Use OnlyReturns a collection of the list's contents.
/lists/{listId}/contents
put
Update a list's contents
Internal-Use OnlyUpdate the contents of a list synchronously via a JSON request body. An update can include the removal of list records.
/lists/{listId}/contents
get
Get a list's unmasked contents
Internal-Use OnlyReturns a collection of the list's unmasked contents.
/lists/{listId}/privilegedContents
put
Update the expiry of a list's rows
Internal-Use OnlyUpdates the expiry property of a list's rows synchronously via a JSON request body.
/lists/{listId}/contents/expiry
post
Delete the expiry of a list's rows
Internal-Use OnlyDeletes the expiry property of a list's rows synchronously via a JSON request body.
/lists/{listId}/contents/expiry/deletions
get
Export a list's contents to a CSV file
Internal-Use OnlyReturns the contents of a list to a CSV file.
/lists/{listId}/contents/export

List Revisions

These endpoints are associated with a list's revisions.
post
Create a list revision
Internal-Use OnlyCreates a new revision for a list.
/lists/{listId}/revisions
get
Get a collection of list revisions
Internal-Use OnlyReturns a collection of revisions for the specified list.
/lists/{listId}/revisions
get
Get a list revision
Internal-Use OnlyReturns a list revision.
/lists/{listId}/revisions/{revisionId}
get
Get a list revision's contents
Internal-Use OnlyReturns a collection of the list revision's contents.
/lists/{listId}/revisions/{revisionId}/contents
get
Get a list revision's unmasked contents
Internal-Use OnlyReturns a collection of the list revision's unmasked contents.
/lists/{listId}/revisions/{revisionId}/privilegedContents
post
Deploy a list revision
Internal-Use OnlyDeploys the specified revision.
/lists/{listId}/revisions/{revisionId}/deploy

List Relations

This endpoint is associated with a list's relationships with other objects that are managed by the Catalog service.
get
Get list consumers
Internal-Use OnlyGets the consumers of a list.
/lists/{listId}/consumers

Update List Content State

These endpoints are associated with updating the deployed state of a list's rows.
put
Update the state of a list's rows
Internal-Use OnlyUpdates the state of a list's rows synchronously via a JSON request body.
/lists/{listId}/contents/state
get
Get a collection of update content state jobs
Internal-Use OnlyReturns a collection of update content state jobs for a specific list. An update content state job updates the state for each row in a list.
/lists/{listId}/updateContentStateJobs
post
Create an update content state job
Internal-Use OnlyUpdates the state for every row in a list.
/lists/{listId}/updateContentStateJobs
get
Get an update content state job
Internal-Use OnlyReturns an update content state job for a specific list. An update content state job updates the state of every row in a list.
/lists/{listId}/updateContentStateJobs/{jobId}