Unicat API Reference

Up - API Reference - Home

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

Requires JWT.

Get one or more records.

A record is a set of product data and metadata in a specific language, with a global id (gid) to uniquely identify it. Records form a tree through their gid and parent properties.

You can specify which languages you want in the results.

The records/get endpoint never takes ordering or channels into account.

Request

You get a record either by specifying the gid in record or a list of gids in records.

If you provide both record and records parameters, then we use parameter matching to guess what you meant. The first action that matches the parameters is performed, the rest is ignored. Parameter matching happens in the order given below:

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

{
    "record": "<record gid>"
}

or

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

{
    "records": ["<record gid>", …]
}

record and records are the record's gid.

optional

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

If you request a single record, you'll get a single result.

Authorization: <JWT>

{
    "success": true,
    "result": {
        "record": "96ec02b2-fb8d-4fb4-b952-fad0c4b88a74"
    },
    "data": {
        "records": {
            "96ec02b2-fb8d-4fb4-b952-fad0c4b88a74": {
                …
            },
            …
        }
    }
}

If you requested multiple records, you'll get a list of results.

Authorization: <JWT>

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

result

record the requested record, if a single record was asked for.
records the requested records, if multiple records were asked for.

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