Skip to main content Skip to complementary content

Get a record by ID

Gets a data record by ID.
Request
GET /services/rest/data/{containerName}/{type}/{id}
Parameters
  • containerName: This is a String value which represents the name of the container where you want to query the record.
  • container: This is a String value which represents the type of the data container. It is either MASTER (default) or STAGING.
  • type: This is a String value which specifies the name of the entity.
  • id: This is a String value which specifies the ID of the record.
  • datetime: This is a String value that specifies the date at which the record you want to retrieve was updated. The date can be provided as number of milliseconds since EPOCH or an XML formatted date.
  • swing: It controls how datetime is interpreted, CLOSEST, AFTER, or BEFORE.
  • ignoreCase: This is a Boolean value which controls whether to ignore the case of the entity and attribute names in JSON response. By default, it is true, which means all entity and attributes names in JSON response will be in lowercase.
Headers
  • Authorization: Basic Authentication scheme
  • Accept: application/json
Response The content of the record in JSON array format.
Status
  • 200 OK: The operation is executed successfully.
  • 400 BAD REQUEST: The request contains invalid parameter, for example, invalid storage name.
  • 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 a record by ID for the Role entity in the PROVISIONING system data container.

Sample response

[
  {
    "product": {
      "picture": "/imageserver/upload/TalendShop/dog.jpg",
      "id": "231035933",
      "name": "Talend Dog T-Shirt",
      "description": "Doggie t-shirt from American Apparel",
      "features": {
        "sizes": {
          "size": [
            "Small",
            "Medium",
            "Large",
            "X-Large"
          ]
        },
        "colors": {
          "color": [
            "White"
          ]
        }
      },
      "availability": "false",
      "price": "16.99",
      "family": "[10]",
      "onlinestore": "Talend Shop@@http://www.cafepress.com/Talend.231035933",
      "stores": {}
    }
  }
]

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!