Unicat API Reference

Up - API Reference - Home

/api/projects/get

Requires JWT.

Get info about a project. You must be the owner or a member of this project.

Request

POST /api/projects/get
Authorization: Bearer <JWT>

{
    "project": "<project gid>"
}

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "project": "<project gid>",
    },
    "data": {
        "cc.projects": {
            "<project gid>": {
                "gid": "<project gid>",
                "name": "Project Name",
                "icon": "<project gid>.jpg",
                "owner": "<owner user gid>",
                "status": "active",
                "options": {
                    "channels": {
                        "__all__": "[all records]",
                        "650ebd0f-eab5-41d7-87c1-1dc5334af872": "Website NL",
                        "4782d5f5-b62b-4ecb-bf71-5be637a15dc5": "Website EN",
                        "23d17876-e3cb-4acf-8eeb-a0154ca83a75": "Catalog NL",
                        "2b1ca5b8-57b7-4f48-8804-c99acc590b26": "Catalog EN",
                        "a9815885-96fd-466d-98fe-f3ae6353abc3": "Pricelist NL",
                        "ab20eeef-dcff-4679-aef9-c3332371b6dd": "Pricelist EN"
                    },
                    "timezone": "Europe/Amsterdam",
                    "languages": [
                        "nl",
                        "en"
                    ],
                    "orderings": {
                        "87b53a4e-359d-45c7-81cb-5e1c3ef444ec": "Catalog",
                        "e4c44479-56ca-47c0-b1f1-9acf40ee3459": "Webshop",
                        "f6c547a3-23ec-4e70-92bc-1826ae53570a": "Pricelist"
                    },
                    "fieldlists": {
                        "31cbd8ac-4f13-4ac3-8924-752ea94d1c65": "Stentor Webshop",
                        "350988c6-22ce-4a74-a2b7-1c25b23eea27": "Catalogger Catalog"
                    },
                    "imageserver": {
                        "type": "ccdam",
                        "options": {}
                    },
                    "orderedchannels": [
                        "__all__",
                        "650ebd0f-eab5-41d7-87c1-1dc5334af872",
                        "4782d5f5-b62b-4ecb-bf71-5be637a15dc5",
                        "23d17876-e3cb-4acf-8eeb-a0154ca83a75",
                        "2b1ca5b8-57b7-4f48-8804-c99acc590b26",
                        "a9815885-96fd-466d-98fe-f3ae6353abc3",
                        "ab20eeef-dcff-4679-aef9-c3332371b6dd"
                    ],
                    "orderedorderings": [
                        "87b53a4e-359d-45c7-81cb-5e1c3ef444ec",
                        "e4c44479-56ca-47c0-b1f1-9acf40ee3459",
                        "f6c547a3-23ec-4e70-92bc-1826ae53570a"
                    ],
                    "orderedfieldlists": [
                        "31cbd8ac-4f13-4ac3-8924-752ea94d1c65",
                        "350988c6-22ce-4a74-a2b7-1c25b23eea27"
                    ]
                },
                "build": 17
            }
        }
    }
}

result

project is the project gid you provided.

data

cc.projects is a dictionary with one entry for the project.

Error response

400 Bad request - missing argument
401 Unauthorized - missing or expired JWT
403 Forbidden - not a member of this project
422 Unprocessable Entity - no info for this project for this user

HTTP/1.1 400 Bad request

{
    "success": false,
    "result": {
        "code": 400,
        "message": "Bad request",
        "info": {}
    },
    "data": {}
}

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer realm="JWT access to Unicat."

{
    "success": false,
    "result": {
        "code": 401,
        "message": "Permission denied",
        "info": {}
    },
    "data": {}
}

HTTP/1.1 403 Forbidden

{
    "success": false,
    "result": {
        "code": 403,
        "message": "Forbidden",
        "info": {}
    },
    "data": {}
}

HTTP/1.1 422 Unprocessable Entity

{
    "success": false,
    "result": {
        "code": 422,
        "message": "Unprocessable Entity",
        "info": {}
    },
    "data": {}
}