Skip to main content Skip to complementary content

Get all document unique IDs

Availability-noteDeprecated
Gets the unique IDs of all documents as array.
Request
GET /services/rest/data/{containerName}/documents/uniqueIds
Parameters
  • containerName: This is a String value which specifies the name of the data container from which you want to get the unique ids of all documents.
  • type: This is a String value which specifies the name of the entity.
Headers
  • Authorization: Basic Authentication scheme
  • Accept: application/json
Response A JSON array that contains all primary keys of the entity in the specified container.
Status
  • 200 OK: The query operation is executed successfully, and the documents unique ids of the specified entity are returned in an array.
  • 400 BAD REQUEST: The request contains invalid parameter, for example, invalid storage name or invalid storage type.
  • 401 UNAUTHORIZED: Login fails, invalid username or password.
  • 403 FORBIDDEN: Missing required permission, for example, no required READ permission.
  • 404 NOT FOUND: The resource does not exist, for example, invalid service URL.
  • 500 INTERNAL SERVER ERROR: Other errors.
Limitation This REST API does not support getting the unique IDs of all documents for the Role entity in the PROVISIONING system data container.

Sample response

[
  "Product.Product.231035935",
  "Product.Product.231035941",
  "Product.Product.231035937",
  "Product.Product.231035938",
  "Product.Product.231035939",
  "Product.Product.231035940",
  "Product.Product.231035934",
  "Product.Product.231035936",
  "Product.Product.231035933"
]

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!