Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/orderings/create

Requires JWT.

Create an ordering.

Request

POST /api/p/<project gid>/orderings/create
Authorization: Bearer <JWT>

{
    "name": "New Ordering Name"
}

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "ordering": "c0e7c5eb-0092-4a47-b92c-d0a398616026",
        "project": "<project gid>"
    },
    "data": {
        "cc.projects": {
            "<project gid>": {
                …,
                "options": {
                    "orderings": {
                        "87b53a4e-359d-45c7-81cb-5e1c3ef444ec": "Catalog",
                        "e4c44479-56ca-47c0-b1f1-9acf40ee3459": "Webshop",
                        "f6c547a3-23ec-4e70-92bc-1826ae53570a": "Pricelist",
                        "c0e7c5eb-0092-4a47-b92c-d0a398616026": "New Ordering Name"
                    },
                    …,
                    "orderedorderings": [
                        "87b53a4e-359d-45c7-81cb-5e1c3ef444ec",
                        "e4c44479-56ca-47c0-b1f1-9acf40ee3459",
                        "f6c547a3-23ec-4e70-92bc-1826ae53570a",
                        "c0e7c5eb-0092-4a47-b92c-d0a398616026"
                    ],
                   …
                },
                …
            }
        }
    }
}

result

ordering the key for the newly created ordering.
project the current project.

data

cc.projects Project updated with new orderings and orderedorderings options.

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