Browse/Create Information Objects

The information objects browse/create REST API endpoint provides data about information objects that exist in the system and allows new ones to be created.

GET /api/informationobjects

Summary of information object data.

Example request:

GET /api/informationobjects HTTP/1.1
Host: example.com

Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json

{
    "results": {
        "422": {
            "updatedAt": "2014-06-19T15:37:31Z",
            "parentId": "1",
            "hasDigitalObject": false,
            "sourceCulture": "en",
            "createdAt": "2014-06-19T15:37:31Z",
            "ancestors": [
                "1"
            ],
            "i18n": {
                "languages": [
                    "en"
                ],
                "en": {
                    "title": "EYfRJFWhiIb6zCdWQoyI"
                }
            },
            "publicationStatusId": "159",
            "levelOfDescriptionId": "375",
            "slug": "eyfrjfwhiib6zcdwqoyi",
            "id": 422,
            "title": "EYfRJFWhiIb6zCdWQoyI"
        },
        "426": {
            "updatedAt": "2014-06-19T15:37:31Z",
            "parentId": "1",
            "hasDigitalObject": false,
            "sourceCulture": "en",
            "createdAt": "2014-06-19T15:37:31Z",
            "ancestors": [
                "1"
            ],
            "i18n": {
                "languages": [
                    "en"
                ],
                "en": {
                    "title": "Wd2yzFfOKsC5oBWsDU4e"
                }
            },
            "publicationStatusId": "159",
            "levelOfDescriptionId": "375",
            "slug": "wd2yzffoksc5obwsdu4e",
            "id": 426,
            "title": "Wd2yzFfOKsC5oBWsDU4e"
        }
    },
    "facets": [ ],
    "total": 101
}

Query Parameters:  

• sort – field to sort on
• sort_direction – sort direction, either asc (ascending) or desc (descending)
• limit – number of information objects to return
• skip – number of information objects to skip (an offset in other words)

Status Codes:

• 200 OK – no error

POST /api/informationobjects

Create an information object.

Example request:

  POST /api/informationobjects HTTP/1.1
  Host: example.com

{
    "title": "Book of Cats",
    "description": "This is a book about cats."
}

Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json

{
    "id": 652,
    "parent_id":1
}

Status Codes:

• 200 OK – no error

Back to API documentation index