Test Enterprise-Class Web CMS Scrivito Free for 30 Days
Test Scrivito Free for 30 Days

Get an object

Fetches an object’s details.

GET /tenants/:tenant_id/revisions/:revision_id/objs/:obj_id
GET /tenants/:tenant_id/workspaces/published/objs/:obj_id
GET /tenants/:tenant_id/workspaces/:working_copy_id/objs/:obj_id

Params

  • tenant_id – The ID of the tenant.
  • revision_id – The ID of the revision.
  • working_copy_id – The ID of the working copy.
  • obj_id – The ID of the CMS object.

Response

The details of the CMS object.

Examples

curl \
  -X GET \
  -H 'Content-Type: application/json' \
  -u 'api_token:MYTOKEN' \
  https://api.scrivito.com/tenants/:tenant_id/revisions/:rev_id/objs/:obj_id
{
  "_created_at": "20170704154214",
  "_id": "8cc6dbb74f5770bf",
  "_obj_class": "Foo",
  "title": [
    "string",
    "Page Title"
  ],
  // more object attributes…
}

With binary objects, their blob would show up as:

{
  "_obj_class": "Image",
  "blob": [
    "binary",
    {"id": "00f8b1560c97eb94/4a7d12c1fde1/some-image.jpg"}
  ],
}

Error codes

  • precondition_not_met.obj_not_found
  • precondition_not_met.revision_not_found
  • precondition_not_met.workspace_not_found

Remarks

  • Attributes are returned in the format "attr_name": attr_value. The names of internal attributes start with an underscore.
  • The _widget_pool attribute contains all the widgets used on a page. Attributes of the widgetlist type reference widgets in the _widget_pool.
  • The values of attributes referring to a user (e.g. _created_by) depend on the user management system involved.
  • The file name part of a blob’s id may include escaped characters. After unescaping, apply URL encoding: encodeURIComponent(unescape(id))