Unicat API Reference

If you want to work with this project, you need to initialize your environment with the returned project-gid, see /api/p/<project gid>/init.

Request

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

{
    "name": "Documentation Project",
    "timezone": "Europe/Amsterdam",
}

All parameters are optional - by default you'll get an untitled project with timezone Europe/Amsterdam.

optional

name a name for the project
timezone the timezone when entering dates in the UI

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "project": "<project gid>",
        "project_members": ["<user gid>"],
    },
    "data": {
        "cc.projects": {
            "<project gid>": {
                "gid": "<project gid>",
                "name": "untitled project",
                "icon": null,
                "owner": "<user gid>",
                "status": "active",
                "options": {
                    "channels": {
                        "__all__": "[all records]",
                        "650ebd0f-eab5-41d7-87c1-1dc5334af872": "Main channel"
                    },
                    "timezone": "Europe/Amsterdam",
                    "languages": [
                        "en",
                        "nl"
                    ],
                    "orderings": {
                        "87b53a4e-359d-45c7-81cb-5e1c3ef444ec": "Main ordering"
                    },
                    "fieldlists": {
                        "31cbd8ac-4f13-4ac3-8924-752ea94d1c65": "Main fieldlist"
                    },
                    "imageserver": {
                        "type": "ccdam",
                        "options": {}
                    },
                    "orderedchannels": [
                        "__all__",
                        "650ebd0f-eab5-41d7-87c1-1dc5334af872"
                    ],
                    "orderedorderings": [
                        "87b53a4e-359d-45c7-81cb-5e1c3ef444ec"
                    ],
                    "orderedfieldlists": [
                        "31cbd8ac-4f13-4ac3-8924-752ea94d1c65"
                    ]
                },
                "build": 1
            }
        },
        "cc.projects_members": [
            {
                "project_gid": "<project gid>",
                "user_gid": "<user gid>",
                "status": "active",
                "roles": [
                    "owner"
                ],
                "options": {
                    "notifications": {
                        "email": "<user email>",
                        "events": [
                            "all"
                        ],
                        "frequency": "immediate"
                    },
                    "rate_limit_per_second": null
                }
            }
        ]
    }
}

result

project is the project gid for the new project.
project_members is the list of members, i.e. you.

data

cc.projects is a dictionary with one entry for the new project.
cc.projects_members is a list with one entry for the new project with its owner.

Error response

401 Unauthorized - missing or expired JWT
422 Unprocessable Entity - could not create a new project

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

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