Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/records/bulk/get

Requires JWT.

Get records in bulk using the selection parameter.

Results are paginated using a cursor.

Learn more about the selection parameter and responses to bulk requests.

Request

POST /api/p/<project gid>/records/bulk/get
Authorization: Bearer <JWT>

{
    "selection": [
        "<gid-1>",
        "<gid-2>",
        "<gid-3>",
        {
            "children": "<gid-9>",
            "channel": <channel key>,
            "ordering": <ordering key>,
            "exclude": ["<gid-x>", "<gid-y>", "<gid-z>"],
        },
        {
            "search": {
                "language": "nl",
                "q": "+cms 225",
                "filter": ["classes", "has", "article"],
            },
            "exclude": ["<gid-a>", "<gid-b>", "<gid-c>"]
        },
    ],
    "page.cursor": <cursor-returned-from-previous-request>,
    "page.size": 100,
}

selection is the selection of records to get.

For children entries, we support optional channel and ordering parameters.

optional

page.cursor must not be present for the first request, and must contain the returned value of the previous request for pagination.
page.size (default 100) only return this many records.
language return data for this (project) language.
languages return data for these (project) languages.

If you request language and/or languages, you get the records' title and fields for the combined set. If you request neither, you'll get all available languages.

Success response

You'll get a list of records and a cursor to fetch the next page.

Authorization: <JWT>

{
    "success": true,
    "result": {
        "records": [
            "96ec02b2-fb8d-4fb4-b952-fad0c4b88a74",
            "7c136ddb-4dfa-4ec1-bad4-15067cbf80d9",
            "726427c2-8c72-4d2e-a09b-937a6f16d3c0"
        ],
        "records.size": 17,
        "page.cursor": <a-cursor-value>,
    },
    "data": {
        "records": {
            "96ec02b2-fb8d-4fb4-b952-fad0c4b88a74": {
                …
            },
            …
        }
    }
}

result

records the requested records.
records.size the total number of records in the selection.
page.cursor a cursor value to be used in the next requests - if it is null, there are no more results available.

Note: if the selection parameter contains invalid record gids, the number of returned records may not match the requested page size. The total size initially includes the invalid gids, but when they are in the current page, the total size is amended -- this means the records.size is not necessarily constant during pagination.

data

records Record info with hierarchy, definition, field values.

Error responses

400 Bad request - missing parameters or wrong type or value
401 Unauthorized - missing or expired JWT
403 Forbidden - not a member of this project
1006 Selection error - selection or cursor parameter is invalid