Skip to content

We provide an OpenAPI specification for certain endpoints and are working on providing this for all endpoints. The latest version is located at api.dasch.swiss/api/docs/docs.yaml. For an interactive documentation of all API endpoints, please visit api.dasch.swiss/api/docs/.

webapi-admin-api v30.16.0

Servers

Description URL
Local development server http://localhost:3333
Production server https://api.dasch.swiss

Admin Groups


GET /admin/groups

Description

Return all groups.

Response 200 OK

{
    "groups": [
        {
            "id": "http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w",
            "name": "NewGroup",
            "descriptions": [
                {
                    "value": "NewGroup description in English",
                    "language": "en"
                },
                {
                    "value": "NewGroup Beschreibung auf Deutsch",
                    "language": "de"
                }
            ],
            "project": {
                "id": "http://rdfh.ch/projects/0042",
                "shortname": "example",
                "shortcode": "0001",
                "longname": "Example Project",
                "description": [
                    {
                        "value": "An example project",
                        "language": "en"
                    }
                ],
                "keywords": [
                    "example",
                    "project"
                ],
                "ontologies": [],
                "status": true,
                "selfjoin": false
            },
            "status": true,
            "selfjoin": false
        }
    ]
}
Schema of the response body
{
    "title": "GroupsGetResponseADM",
    "type": "object",
    "properties": {
        "groups": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Group"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

POST /admin/groups

Description

Required permissions: User must SystemAdmin or ProjectAdmin of the project the group is created in.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Request body

{
    "name": "NewGroup",
    "descriptions": [
        {
            "value": "NewGroup description in English",
            "language": "en"
        },
        {
            "value": "NewGroup Beschreibung auf Deutsch",
            "language": "de"
        }
    ],
    "project": "http://rdfh.ch/projects/0042",
    "status": true,
    "selfjoin": false
}
Schema of the request body
{
    "title": "GroupCreateRequest",
    "type": "object",
    "required": [
        "name",
        "descriptions",
        "project",
        "status",
        "selfjoin"
    ],
    "properties": {
        "id": {
            "$ref": "#/components/schemas/GroupIri"
        },
        "name": {
            "$ref": "#/components/schemas/GroupName"
        },
        "descriptions": {
            "$ref": "#/components/schemas/GroupDescriptions"
        },
        "project": {
            "$ref": "#/components/schemas/ProjectIri"
        },
        "status": {
            "$ref": "#/components/schemas/GroupStatus"
        },
        "selfjoin": {
            "$ref": "#/components/schemas/GroupSelfJoin"
        }
    }
}

Response 200 OK

{
    "group": {
        "id": "http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w",
        "name": "NewGroup",
        "descriptions": [
            {
                "value": "NewGroup description in English",
                "language": "en"
            },
            {
                "value": "NewGroup Beschreibung auf Deutsch",
                "language": "de"
            }
        ],
        "project": {
            "id": "http://rdfh.ch/projects/0042",
            "shortname": "example",
            "shortcode": "0001",
            "longname": "Example Project",
            "description": [
                {
                    "value": "An example project",
                    "language": "en"
                }
            ],
            "keywords": [
                "example",
                "project"
            ],
            "ontologies": [],
            "status": true,
            "selfjoin": false
        },
        "status": true,
        "selfjoin": false
    }
}
Schema of the response body
{
    "title": "GroupGetResponseADM",
    "type": "object",
    "required": [
        "group"
    ],
    "properties": {
        "group": {
            "$ref": "#/components/schemas/Group"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/groups/{groupIri}

Description

Return a single group identified by its IRI.

Input parameters

Parameter In Type Default Nullable Description
groupIri path string No The IRI of a group. Must be URL-encoded.

Response 200 OK

{
    "group": {
        "id": "http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w",
        "name": "NewGroup",
        "descriptions": [
            {
                "value": "NewGroup description in English",
                "language": "en"
            },
            {
                "value": "NewGroup Beschreibung auf Deutsch",
                "language": "de"
            }
        ],
        "project": {
            "id": "http://rdfh.ch/projects/0042",
            "shortname": "example",
            "shortcode": "0001",
            "longname": "Example Project",
            "description": [
                {
                    "value": "An example project",
                    "language": "en"
                }
            ],
            "keywords": [
                "example",
                "project"
            ],
            "ontologies": [],
            "status": true,
            "selfjoin": false
        },
        "status": true,
        "selfjoin": false
    }
}
Schema of the response body
{
    "title": "GroupGetResponseADM",
    "type": "object",
    "required": [
        "group"
    ],
    "properties": {
        "group": {
            "$ref": "#/components/schemas/Group"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/groups/{groupIri}

Description

Update a group's basic information.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
groupIri path string No The IRI of a group. Must be URL-encoded.
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Request body

{
    "name": "NewGroupNewName",
    "descriptions": [
        {
            "value": "NewGroupNewName description in English",
            "language": "en"
        },
        {
            "value": "NewGroupNewName Beschreibung auf Deutsch",
            "language": "de"
        }
    ],
    "status": false,
    "selfjoin": true
}
Schema of the request body
{
    "title": "GroupUpdateRequest",
    "type": "object",
    "properties": {
        "name": {
            "$ref": "#/components/schemas/GroupName"
        },
        "descriptions": {
            "$ref": "#/components/schemas/GroupDescriptions"
        },
        "status": {
            "$ref": "#/components/schemas/GroupStatus"
        },
        "selfjoin": {
            "$ref": "#/components/schemas/GroupSelfJoin"
        }
    }
}

Response 200 OK

{
    "group": {
        "id": "http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w",
        "name": "NewGroup",
        "descriptions": [
            {
                "value": "NewGroup description in English",
                "language": "en"
            },
            {
                "value": "NewGroup Beschreibung auf Deutsch",
                "language": "de"
            }
        ],
        "project": {
            "id": "http://rdfh.ch/projects/0042",
            "shortname": "example",
            "shortcode": "0001",
            "longname": "Example Project",
            "description": [
                {
                    "value": "An example project",
                    "language": "en"
                }
            ],
            "keywords": [
                "example",
                "project"
            ],
            "ontologies": [],
            "status": true,
            "selfjoin": false
        },
        "status": true,
        "selfjoin": false
    }
}
Schema of the response body
{
    "title": "GroupGetResponseADM",
    "type": "object",
    "required": [
        "group"
    ],
    "properties": {
        "group": {
            "$ref": "#/components/schemas/Group"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

DELETE /admin/groups/{groupIri}

Description

Deletes a group by changing its status to 'false'.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
groupIri path string No The IRI of a group. Must be URL-encoded.
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Response 200 OK

{
    "group": {
        "id": "http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w",
        "name": "NewGroup",
        "descriptions": [
            {
                "value": "NewGroup description in English",
                "language": "en"
            },
            {
                "value": "NewGroup Beschreibung auf Deutsch",
                "language": "de"
            }
        ],
        "project": {
            "id": "http://rdfh.ch/projects/0042",
            "shortname": "example",
            "shortcode": "0001",
            "longname": "Example Project",
            "description": [
                {
                    "value": "An example project",
                    "language": "en"
                }
            ],
            "keywords": [
                "example",
                "project"
            ],
            "ontologies": [],
            "status": true,
            "selfjoin": false
        },
        "status": true,
        "selfjoin": false
    }
}
Schema of the response body
{
    "title": "GroupGetResponseADM",
    "type": "object",
    "required": [
        "group"
    ],
    "properties": {
        "group": {
            "$ref": "#/components/schemas/Group"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/groups/{groupIri}/members

Description

Return all members of a single group.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
groupIri path string No The IRI of a group. Must be URL-encoded.
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Response 200 OK

{
    "members": [
        {
            "id": "http://rdfh.ch/users/0001",
            "username": "username",
            "email": "user@exampl.com",
            "givenName": "Jane",
            "familyName": "Doe",
            "status": true,
            "lang": "rm",
            "groups": [
                {
                    "id": "http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w",
                    "name": "NewGroup",
                    "descriptions": [
                        {
                            "value": "NewGroup description in English",
                            "language": "en"
                        },
                        {
                            "value": "NewGroup Beschreibung auf Deutsch",
                            "language": "de"
                        }
                    ],
                    "project": {
                        "id": "http://rdfh.ch/projects/0042",
                        "shortname": "example",
                        "shortcode": "0001",
                        "longname": "Example Project",
                        "description": [
                            {
                                "value": "An example project",
                                "language": "en"
                            }
                        ],
                        "keywords": [
                            "example",
                            "project"
                        ],
                        "ontologies": [],
                        "status": true,
                        "selfjoin": false
                    },
                    "status": true,
                    "selfjoin": false
                }
            ],
            "projects": [
                {
                    "id": "http://rdfh.ch/projects/0042",
                    "shortname": "example",
                    "shortcode": "0001",
                    "longname": "Example Project",
                    "description": [
                        {
                            "value": "An example project",
                            "language": "en"
                        }
                    ],
                    "keywords": [
                        "example",
                        "project"
                    ],
                    "ontologies": [],
                    "status": true,
                    "selfjoin": false
                }
            ],
            "permissions": {
                "groupsPerProject": {},
                "administrativePermissionsPerProject": {}
            }
        }
    ]
}
Schema of the response body
{
    "title": "GroupMembersGetResponseADM",
    "type": "object",
    "properties": {
        "members": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/User"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/groups/{groupIri}/status

Description

Updates a group's status.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
groupIri path string No The IRI of a group. Must be URL-encoded.
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Request body

{
    "status": {
        "value": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "GroupStatusUpdateRequest",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/GroupStatus"
        }
    }
}

Response 200 OK

{
    "group": {
        "id": "http://rdfh.ch/groups/0042/a95UWs71KUklnFOe1rcw1w",
        "name": "NewGroup",
        "descriptions": [
            {
                "value": "NewGroup description in English",
                "language": "en"
            },
            {
                "value": "NewGroup Beschreibung auf Deutsch",
                "language": "de"
            }
        ],
        "project": {
            "id": "http://rdfh.ch/projects/0042",
            "shortname": "example",
            "shortcode": "0001",
            "longname": "Example Project",
            "description": [
                {
                    "value": "An example project",
                    "language": "en"
                }
            ],
            "keywords": [
                "example",
                "project"
            ],
            "ontologies": [],
            "status": true,
            "selfjoin": false
        },
        "status": true,
        "selfjoin": false
    }
}
Schema of the response body
{
    "title": "GroupGetResponseADM",
    "type": "object",
    "required": [
        "group"
    ],
    "properties": {
        "group": {
            "$ref": "#/components/schemas/Group"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Admin Lists


GET /admin/lists

Description

Get all lists or all lists belonging to a project.

Input parameters

Parameter In Type Default Nullable Description
projectIri query string No The (optional) IRI of the project.

Response 200 OK

{
    "lists": [
        {
            "id": "string",
            "projectIri": "string",
            "name": "string",
            "labels": {
                "stringLiterals": [
                    {
                        "value": "string",
                        "language": "string"
                    }
                ]
            },
            "comments": null,
            "isRootNode": true
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ListsGetResponseADM",
    "type": "object",
    "properties": {
        "lists": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ListRootNodeInfoADM"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

POST /admin/lists

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Request body

{
    "id": {
        "value": "string"
    },
    "comments": {
        "value": [
            {
                "value": "string",
                "language": "string"
            }
        ]
    },
    "labels": {
        "value": null
    },
    "name": {
        "value": "string"
    },
    "projectIri": {
        "value": "string"
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ListCreateRootNodeRequest",
    "type": "object",
    "required": [
        "comments",
        "labels",
        "projectIri"
    ],
    "properties": {
        "id": {
            "$ref": "#/components/schemas/ListIri"
        },
        "comments": {
            "$ref": "#/components/schemas/Comments"
        },
        "labels": {
            "$ref": "#/components/schemas/Labels"
        },
        "name": {
            "$ref": "#/components/schemas/ListName"
        },
        "projectIri": {
            "$ref": "#/components/schemas/ProjectIri"
        }
    }
}

Response 200 OK

{
    "list": {
        "listinfo": {
            "id": "string",
            "projectIri": "string",
            "name": "string",
            "labels": {
                "stringLiterals": [
                    {
                        "value": "string",
                        "language": "string"
                    }
                ]
            },
            "comments": null,
            "isRootNode": true
        },
        "children": [
            {
                "id": "string",
                "name": "string",
                "labels": null,
                "comments": null,
                "position": 149,
                "hasRootNode": "string",
                "children": null
            }
        ]
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ListGetResponseADM",
    "type": "object",
    "required": [
        "list"
    ],
    "properties": {
        "list": {
            "$ref": "#/components/schemas/ListADM"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/lists/{p1}/name

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
p1 path string No The IRI of the list.

Request body

{
    "name": {
        "value": "string"
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ListChangeNameRequest",
    "type": "object",
    "required": [
        "name"
    ],
    "properties": {
        "name": {
            "$ref": "#/components/schemas/ListName"
        }
    }
}

Response 200 OK

Schema of the response body
{
    "title": "NodeInfoGetResponseADM",
    "oneOf": [
        {
            "$ref": "#/components/schemas/ChildNodeInfoGetResponseADM"
        },
        {
            "$ref": "#/components/schemas/RootNodeInfoGetResponseADM"
        }
    ]
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/lists/{p1}/labels

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
p1 path string No The IRI of the list.

Request body

{
    "labels": {
        "value": [
            {
                "value": "string",
                "language": "string"
            }
        ]
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ListChangeLabelsRequest",
    "type": "object",
    "required": [
        "labels"
    ],
    "properties": {
        "labels": {
            "$ref": "#/components/schemas/Labels"
        }
    }
}

Response 200 OK

Schema of the response body
{
    "title": "NodeInfoGetResponseADM",
    "oneOf": [
        {
            "$ref": "#/components/schemas/ChildNodeInfoGetResponseADM"
        },
        {
            "$ref": "#/components/schemas/RootNodeInfoGetResponseADM"
        }
    ]
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/lists/{p1}/comments

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
p1 path string No The IRI of the list.

Request body

{
    "comments": {
        "value": [
            {
                "value": "string",
                "language": "string"
            }
        ]
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ListChangeCommentsRequest",
    "type": "object",
    "required": [
        "comments"
    ],
    "properties": {
        "comments": {
            "$ref": "#/components/schemas/Comments"
        }
    }
}

Response 200 OK

Schema of the response body
{
    "title": "NodeInfoGetResponseADM",
    "oneOf": [
        {
            "$ref": "#/components/schemas/ChildNodeInfoGetResponseADM"
        },
        {
            "$ref": "#/components/schemas/RootNodeInfoGetResponseADM"
        }
    ]
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/lists/{p1}/position

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
p1 path string No The IRI of the list.

Request body

{
    "position": {
        "value": 220
    },
    "parentNodeIri": {
        "value": "string"
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ListChangePositionRequest",
    "type": "object",
    "required": [
        "position",
        "parentNodeIri"
    ],
    "properties": {
        "position": {
            "$ref": "#/components/schemas/Position"
        },
        "parentNodeIri": {
            "$ref": "#/components/schemas/ListIri"
        }
    }
}

Response 200 OK

{
    "node": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NodePositionChangeResponseADM",
    "type": "object",
    "required": [
        "node"
    ],
    "properties": {
        "node": {
            "$ref": "#/components/schemas/ListNodeADM"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/lists/{p1}

Description

Returns a list node, root or child, with children (if exist).

Input parameters

Parameter In Type Default Nullable Description
p1 path string No The IRI of the list.

Response 200 OK

Schema of the response body
{
    "title": "ListItemGetResponseADM",
    "oneOf": [
        {
            "$ref": "#/components/schemas/ListGetResponseADM"
        },
        {
            "$ref": "#/components/schemas/ListNodeGetResponseADM"
        }
    ]
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/lists/{p1}

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
p1 path string No The IRI of the list.

Request body

{
    "listIri": {
        "value": "string"
    },
    "projectIri": {
        "value": "string"
    },
    "hasRootNode": null,
    "position": {
        "value": 193
    },
    "name": {
        "value": "string"
    },
    "labels": {
        "value": [
            {
                "value": "string",
                "language": "string"
            }
        ]
    },
    "comments": {
        "value": null
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ListChangeRequest",
    "type": "object",
    "required": [
        "listIri",
        "projectIri"
    ],
    "properties": {
        "listIri": {
            "$ref": "#/components/schemas/ListIri"
        },
        "projectIri": {
            "$ref": "#/components/schemas/ProjectIri"
        },
        "hasRootNode": {
            "$ref": "#/components/schemas/ListIri"
        },
        "position": {
            "$ref": "#/components/schemas/Position"
        },
        "name": {
            "$ref": "#/components/schemas/ListName"
        },
        "labels": {
            "$ref": "#/components/schemas/Labels"
        },
        "comments": {
            "$ref": "#/components/schemas/Comments"
        }
    }
}

Response 200 OK

Schema of the response body
{
    "title": "NodeInfoGetResponseADM",
    "oneOf": [
        {
            "$ref": "#/components/schemas/ChildNodeInfoGetResponseADM"
        },
        {
            "$ref": "#/components/schemas/RootNodeInfoGetResponseADM"
        }
    ]
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

DELETE /admin/lists/{p1}

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
p1 path string No The IRI of the list.

Response 200 OK

Schema of the response body
{
    "title": "ListItemDeleteResponseADM",
    "oneOf": [
        {
            "$ref": "#/components/schemas/ChildNodeDeleteResponseADM"
        },
        {
            "$ref": "#/components/schemas/ListDeleteResponseADM"
        }
    ]
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

DELETE /admin/lists/comments/{p1}

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
p1 path string No The IRI of the list.

Response 200 OK

{
    "nodeIri": "string",
    "commentsDeleted": true
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ListNodeCommentsDeleteResponseADM",
    "type": "object",
    "required": [
        "nodeIri",
        "commentsDeleted"
    ],
    "properties": {
        "nodeIri": {
            "type": "string"
        },
        "commentsDeleted": {
            "type": "boolean"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/lists/{p1}/info

Description

Returns basic information about a list node, root or child, w/o children (if exist).

Input parameters

Parameter In Type Default Nullable Description
p1 path string No The IRI of the list.

Response 200 OK

Schema of the response body
{
    "title": "NodeInfoGetResponseADM",
    "oneOf": [
        {
            "$ref": "#/components/schemas/ChildNodeInfoGetResponseADM"
        },
        {
            "$ref": "#/components/schemas/RootNodeInfoGetResponseADM"
        }
    ]
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/lists/candelete/{p1}

Description

Checks if a list can be deleted (none of its nodes is used in data).

Input parameters

Parameter In Type Default Nullable Description
p1 path string No The IRI of the list.

Response 200 OK

{
    "listIri": "string",
    "canDeleteList": true
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "CanDeleteListResponseADM",
    "type": "object",
    "required": [
        "listIri",
        "canDeleteList"
    ],
    "properties": {
        "listIri": {
            "type": "string"
        },
        "canDeleteList": {
            "type": "boolean"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Admin Maintenance


POST /admin/maintenance/{action-name}

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
action-name path string No The name of the maintenance action to be executed. Maintenance actions are executed asynchronously in the background.
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Request body

"string"
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "type": "string"
}

Response 202 Accepted

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Admin Permissions


POST /admin/permissions/ap

Description

Create a new administrative permission

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Request body

{
    "id": "string",
    "forProject": "string",
    "forGroup": "string",
    "hasPermissions": [
        {
            "name": "string",
            "additionalInformation": "string",
            "permissionCode": 14
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "CreateAdministrativePermissionAPIRequestADM",
    "type": "object",
    "required": [
        "forProject",
        "forGroup"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "forProject": {
            "type": "string"
        },
        "forGroup": {
            "type": "string"
        },
        "hasPermissions": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "$ref": "#/components/schemas/PermissionADM"
            }
        }
    }
}

Response 200 OK

{
    "administrativePermission": {
        "iri": "string",
        "forProject": "string",
        "forGroup": "string",
        "hasPermissions": [
            {
                "name": "string",
                "additionalInformation": "string",
                "permissionCode": 19
            }
        ]
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "AdministrativePermissionCreateResponseADM",
    "type": "object",
    "required": [
        "administrativePermission"
    ],
    "properties": {
        "administrativePermission": {
            "$ref": "#/components/schemas/AdministrativePermissionADM"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/permissions/ap/{projectIri}

Description

Get all administrative permissions for a project.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectIri path string No The IRI of a project. Must be URL-encoded.

Response 200 OK

{
    "administrativePermissions": [
        {
            "iri": "string",
            "forProject": "string",
            "forGroup": "string",
            "hasPermissions": [
                {
                    "name": "string",
                    "additionalInformation": "string",
                    "permissionCode": 237
                }
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "AdministrativePermissionsForProjectGetResponseADM",
    "type": "object",
    "properties": {
        "administrativePermissions": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/AdministrativePermissionADM"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/permissions/ap/{projectIri}/{groupIri}

Description

Get all administrative permissions for a project and a group.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
groupIri path string No The IRI of a group. Must be URL-encoded.
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectIri path string No The IRI of a project. Must be URL-encoded.

Response 200 OK

{
    "administrativePermission": {
        "iri": "string",
        "forProject": "string",
        "forGroup": "string",
        "hasPermissions": [
            {
                "name": "string",
                "additionalInformation": "string",
                "permissionCode": 213
            }
        ]
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "AdministrativePermissionGetResponseADM",
    "type": "object",
    "required": [
        "administrativePermission"
    ],
    "properties": {
        "administrativePermission": {
            "$ref": "#/components/schemas/AdministrativePermissionADM"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/permissions/doap/{projectIri}

Description

Get all default object access permissions for a project.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectIri path string No The IRI of a project. Must be URL-encoded.

Response 200 OK

{
    "defaultObjectAccessPermissions": [
        {
            "iri": "string",
            "forProject": "string",
            "forGroup": "string",
            "forResourceClass": "string",
            "forProperty": "string",
            "hasPermissions": [
                {
                    "name": "string",
                    "additionalInformation": "string",
                    "permissionCode": 229
                }
            ]
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "DefaultObjectAccessPermissionsForProjectGetResponseADM",
    "type": "object",
    "properties": {
        "defaultObjectAccessPermissions": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/DefaultObjectAccessPermissionADM"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/permissions/{projectIri}

Description

Get all permissions for a project.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectIri path string No The IRI of a project. Must be URL-encoded.

Response 200 OK

{
    "permissions": [
        {
            "iri": "string",
            "permissionType": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "PermissionsForProjectGetResponseADM",
    "type": "object",
    "properties": {
        "permissions": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "$ref": "#/components/schemas/PermissionInfoADM"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

DELETE /admin/permissions/{permissionIri}

Description

Delete an permission.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
permissionIri path string No The IRI of a permission. Must be URL-encoded.

Response 200 OK

{
    "permissionIri": "string",
    "deleted": true
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "PermissionDeleteResponseADM",
    "type": "object",
    "required": [
        "permissionIri",
        "deleted"
    ],
    "properties": {
        "permissionIri": {
            "type": "string"
        },
        "deleted": {
            "type": "boolean"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

POST /admin/permissions/doap

Description

Create a new default object access permission

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Request body

{
    "id": "string",
    "forProject": "string",
    "forGroup": "string",
    "forResourceClass": "string",
    "forProperty": "string",
    "hasPermissions": [
        {
            "name": "string",
            "additionalInformation": "string",
            "permissionCode": 34
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "CreateDefaultObjectAccessPermissionAPIRequestADM",
    "type": "object",
    "required": [
        "forProject"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "forProject": {
            "type": "string"
        },
        "forGroup": {
            "type": "string"
        },
        "forResourceClass": {
            "type": "string"
        },
        "forProperty": {
            "type": "string"
        },
        "hasPermissions": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "$ref": "#/components/schemas/PermissionADM"
            }
        }
    }
}

Response 200 OK

{
    "defaultObjectAccessPermission": {
        "iri": "string",
        "forProject": "string",
        "forGroup": "string",
        "forResourceClass": "string",
        "forProperty": "string",
        "hasPermissions": [
            {
                "name": "string",
                "additionalInformation": "string",
                "permissionCode": 53
            }
        ]
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "DefaultObjectAccessPermissionCreateResponseADM",
    "type": "object",
    "required": [
        "defaultObjectAccessPermission"
    ],
    "properties": {
        "defaultObjectAccessPermission": {
            "$ref": "#/components/schemas/DefaultObjectAccessPermissionADM"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/permissions/{permissionIri}/group

Description

Update a permission's group

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
permissionIri path string No The IRI of a permission. Must be URL-encoded.

Request body

{
    "forGroup": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ChangePermissionGroupApiRequestADM",
    "type": "object",
    "required": [
        "forGroup"
    ],
    "properties": {
        "forGroup": {
            "type": "string"
        }
    }
}

Response 200 OK

Schema of the response body
{
    "title": "PermissionGetResponseADM",
    "oneOf": [
        {
            "$ref": "#/components/schemas/AdministrativePermissionGetResponseADM"
        },
        {
            "$ref": "#/components/schemas/DefaultObjectAccessPermissionGetResponseADM"
        }
    ]
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/permissions/{permissionIri}/hasPermissions

Description

Update a permission's set of hasPermissions

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
permissionIri path string No The IRI of a permission. Must be URL-encoded.

Request body

{
    "hasPermissions": [
        {
            "name": "string",
            "additionalInformation": "string",
            "permissionCode": 189
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ChangePermissionHasPermissionsApiRequestADM",
    "type": "object",
    "properties": {
        "hasPermissions": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "$ref": "#/components/schemas/PermissionADM"
            }
        }
    }
}

Response 200 OK

Schema of the response body
{
    "title": "PermissionGetResponseADM",
    "oneOf": [
        {
            "$ref": "#/components/schemas/AdministrativePermissionGetResponseADM"
        },
        {
            "$ref": "#/components/schemas/DefaultObjectAccessPermissionGetResponseADM"
        }
    ]
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/permissions/{permissionIri}/resourceClass

Description

Update a permission's resource class

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
permissionIri path string No The IRI of a permission. Must be URL-encoded.

Request body

{
    "forResourceClass": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ChangePermissionResourceClassApiRequestADM",
    "type": "object",
    "required": [
        "forResourceClass"
    ],
    "properties": {
        "forResourceClass": {
            "type": "string"
        }
    }
}

Response 200 OK

Schema of the response body
{
    "title": "PermissionGetResponseADM",
    "oneOf": [
        {
            "$ref": "#/components/schemas/AdministrativePermissionGetResponseADM"
        },
        {
            "$ref": "#/components/schemas/DefaultObjectAccessPermissionGetResponseADM"
        }
    ]
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/permissions/{permissionIri}/property

Description

Update a permission's property

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
permissionIri path string No The IRI of a permission. Must be URL-encoded.

Request body

{
    "forProperty": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ChangePermissionPropertyApiRequestADM",
    "type": "object",
    "required": [
        "forProperty"
    ],
    "properties": {
        "forProperty": {
            "type": "string"
        }
    }
}

Response 200 OK

Schema of the response body
{
    "title": "PermissionGetResponseADM",
    "oneOf": [
        {
            "$ref": "#/components/schemas/AdministrativePermissionGetResponseADM"
        },
        {
            "$ref": "#/components/schemas/DefaultObjectAccessPermissionGetResponseADM"
        }
    ]
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Admin Projects


GET /admin/projects

Description

Returns all projects.

Response 200 OK

{
    "projects": [
        {
            "id": "string",
            "shortname": "string",
            "shortcode": "string",
            "longname": "string",
            "description": [
                {
                    "value": "string",
                    "language": "string"
                }
            ],
            "keywords": [
                "string"
            ],
            "logo": "string",
            "ontologies": [
                "string"
            ],
            "status": true,
            "selfjoin": true
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectsGetResponse",
    "type": "object",
    "properties": {
        "projects": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Project"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

POST /admin/projects

Description

Creates a new project.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Request body

{
    "id": {
        "value": "string"
    },
    "shortname": {
        "value": "string"
    },
    "shortcode": {
        "value": "string"
    },
    "longname": {
        "value": "string"
    },
    "description": [
        {
            "value": {
                "value": "string",
                "language": "string"
            }
        }
    ],
    "keywords": [
        {
            "value": "string"
        }
    ],
    "logo": {
        "value": "string"
    },
    "status": null,
    "selfjoin": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ProjectCreateRequest",
    "type": "object",
    "required": [
        "shortname",
        "shortcode",
        "status",
        "selfjoin"
    ],
    "properties": {
        "id": {
            "$ref": "#/components/schemas/ProjectIri"
        },
        "shortname": {
            "$ref": "#/components/schemas/Shortname"
        },
        "shortcode": {
            "$ref": "#/components/schemas/Shortcode"
        },
        "longname": {
            "$ref": "#/components/schemas/Longname"
        },
        "description": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Description"
            }
        },
        "keywords": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Keyword"
            }
        },
        "logo": {
            "$ref": "#/components/schemas/Logo"
        },
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "selfjoin": {
            "$ref": "#/components/schemas/SelfJoin"
        }
    }
}

Response 200 OK

{
    "project": {
        "id": "string",
        "shortname": "string",
        "shortcode": "string",
        "longname": "string",
        "description": [
            {
                "value": "string",
                "language": "string"
            }
        ],
        "keywords": [
            "string"
        ],
        "logo": "string",
        "ontologies": [
            "string"
        ],
        "status": true,
        "selfjoin": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectOperationResponseADM",
    "type": "object",
    "required": [
        "project"
    ],
    "properties": {
        "project": {
            "$ref": "#/components/schemas/Project"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/iri/{projectIri}

Description

Returns a single project identified by the IRI.

Input parameters

Parameter In Type Default Nullable Description
projectIri path string No The IRI of a project. Must be URL-encoded.

Response 200 OK

{
    "project": {
        "id": "string",
        "shortname": "string",
        "shortcode": "string",
        "longname": "string",
        "description": [
            {
                "value": "string",
                "language": "string"
            }
        ],
        "keywords": [
            "string"
        ],
        "logo": "string",
        "ontologies": [
            "string"
        ],
        "status": true,
        "selfjoin": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectGetResponse",
    "type": "object",
    "required": [
        "project"
    ],
    "properties": {
        "project": {
            "$ref": "#/components/schemas/Project"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

PUT /admin/projects/iri/{projectIri}

Description

Updates a project identified by the IRI.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectIri path string No The IRI of a project. Must be URL-encoded.

Request body

{
    "shortname": {
        "value": "string"
    },
    "longname": {
        "value": "string"
    },
    "description": [
        {
            "value": {
                "value": "string",
                "language": "string"
            }
        }
    ],
    "keywords": [
        {
            "value": "string"
        }
    ],
    "logo": {
        "value": "string"
    },
    "status": null,
    "selfjoin": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "title": "ProjectUpdateRequest",
    "type": "object",
    "properties": {
        "shortname": {
            "$ref": "#/components/schemas/Shortname"
        },
        "longname": {
            "$ref": "#/components/schemas/Longname"
        },
        "description": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Description"
            }
        },
        "keywords": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Keyword"
            }
        },
        "logo": {
            "$ref": "#/components/schemas/Logo"
        },
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "selfjoin": {
            "$ref": "#/components/schemas/SelfJoin"
        }
    }
}

Response 200 OK

{
    "project": {
        "id": "string",
        "shortname": "string",
        "shortcode": "string",
        "longname": "string",
        "description": [
            {
                "value": "string",
                "language": "string"
            }
        ],
        "keywords": [
            "string"
        ],
        "logo": "string",
        "ontologies": [
            "string"
        ],
        "status": true,
        "selfjoin": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectOperationResponseADM",
    "type": "object",
    "required": [
        "project"
    ],
    "properties": {
        "project": {
            "$ref": "#/components/schemas/Project"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

DELETE /admin/projects/iri/{projectIri}

Description

Deletes a project identified by the IRI.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectIri path string No The IRI of a project. Must be URL-encoded.

Response 200 OK

{
    "project": {
        "id": "string",
        "shortname": "string",
        "shortcode": "string",
        "longname": "string",
        "description": [
            {
                "value": "string",
                "language": "string"
            }
        ],
        "keywords": [
            "string"
        ],
        "logo": "string",
        "ontologies": [
            "string"
        ],
        "status": true,
        "selfjoin": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectOperationResponseADM",
    "type": "object",
    "required": [
        "project"
    ],
    "properties": {
        "project": {
            "$ref": "#/components/schemas/Project"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/iri/{projectIri}/RestrictedViewSettings

Description

Returns the project's restricted view settings identified by the IRI.

Input parameters

Parameter In Type Default Nullable Description
projectIri path string No The IRI of a project. Must be URL-encoded.

Response 200 OK

{
    "settings": {
        "size": "string",
        "watermark": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectRestrictedViewSettingsGetResponseADM",
    "type": "object",
    "required": [
        "settings"
    ],
    "properties": {
        "settings": {
            "$ref": "#/components/schemas/ProjectRestrictedViewSettingsADM"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

POST /admin/projects/iri/{projectIri}/RestrictedViewSettings

Description

Sets the project's restricted view settings identified by the IRI.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectIri path string No The IRI of a project. Must be URL-encoded.

Request body

{
    "size": "!128,128"
}
Schema of the request body
{
    "title": "SetRestrictedViewRequest",
    "type": "object",
    "properties": {
        "size": {
            "$ref": "#/components/schemas/Size"
        },
        "watermark": {
            "$ref": "#/components/schemas/Watermark"
        }
    }
}

Response 200 OK

{
    "size": {
        "value": "string"
    },
    "watermark": {
        "value": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "RestrictedViewResponse",
    "type": "object",
    "properties": {
        "size": {
            "$ref": "#/components/schemas/Size"
        },
        "watermark": {
            "$ref": "#/components/schemas/Watermark"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/shortcode/{projectShortcode}

Description

Returns a single project identified by the shortcode.

Input parameters

Parameter In Type Default Nullable Description
projectShortcode path string No The shortcode of a project. Must be a 4 digit hexadecimal String.

Response 200 OK

{
    "project": {
        "id": "string",
        "shortname": "string",
        "shortcode": "string",
        "longname": "string",
        "description": [
            {
                "value": "string",
                "language": "string"
            }
        ],
        "keywords": [
            "string"
        ],
        "logo": "string",
        "ontologies": [
            "string"
        ],
        "status": true,
        "selfjoin": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectGetResponse",
    "type": "object",
    "required": [
        "project"
    ],
    "properties": {
        "project": {
            "$ref": "#/components/schemas/Project"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/shortcode/{projectShortcode}/RestrictedViewSettings

Description

Returns the project's restricted view settings identified by the shortcode.

Input parameters

Parameter In Type Default Nullable Description
projectShortcode path string No The shortcode of a project. Must be a 4 digit hexadecimal String.

Response 200 OK

{
    "settings": {
        "size": "string",
        "watermark": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectRestrictedViewSettingsGetResponseADM",
    "type": "object",
    "required": [
        "settings"
    ],
    "properties": {
        "settings": {
            "$ref": "#/components/schemas/ProjectRestrictedViewSettingsADM"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

POST /admin/projects/shortcode/{projectShortcode}/RestrictedViewSettings

Description

Sets the project's restricted view settings identified by the shortcode.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectShortcode path string No The shortcode of a project. Must be a 4 digit hexadecimal String.

Request body

{
    "size": "!128,128"
}
Schema of the request body
{
    "title": "SetRestrictedViewRequest",
    "type": "object",
    "properties": {
        "size": {
            "$ref": "#/components/schemas/Size"
        },
        "watermark": {
            "$ref": "#/components/schemas/Watermark"
        }
    }
}

Response 200 OK

{
    "size": {
        "value": "string"
    },
    "watermark": {
        "value": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "RestrictedViewResponse",
    "type": "object",
    "properties": {
        "size": {
            "$ref": "#/components/schemas/Size"
        },
        "watermark": {
            "$ref": "#/components/schemas/Watermark"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/shortname/{projectShortname}

Description

Returns a single project identified by the shortname.

Input parameters

Parameter In Type Default Nullable Description
projectShortname path string No The shortname of a project.

Response 200 OK

{
    "project": {
        "id": "string",
        "shortname": "string",
        "shortcode": "string",
        "longname": "string",
        "description": [
            {
                "value": "string",
                "language": "string"
            }
        ],
        "keywords": [
            "string"
        ],
        "logo": "string",
        "ontologies": [
            "string"
        ],
        "status": true,
        "selfjoin": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectGetResponse",
    "type": "object",
    "required": [
        "project"
    ],
    "properties": {
        "project": {
            "$ref": "#/components/schemas/Project"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/shortname/{projectShortname}/RestrictedViewSettings

Description

Returns the project's restricted view settings identified by the shortname.

Input parameters

Parameter In Type Default Nullable Description
projectShortname path string No The shortname of a project.

Response 200 OK

{
    "settings": {
        "size": "string",
        "watermark": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectRestrictedViewSettingsGetResponseADM",
    "type": "object",
    "required": [
        "settings"
    ],
    "properties": {
        "settings": {
            "$ref": "#/components/schemas/ProjectRestrictedViewSettingsADM"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/Keywords

Description

Returns all unique keywords for all projects as a list.

Response 200 OK

{
    "keywords": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectsKeywordsGetResponse",
    "type": "object",
    "properties": {
        "keywords": {
            "type": "array",
            "items": {
                "type": "string"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/iri/{projectIri}/Keywords

Description

Returns all keywords for a single project.

Input parameters

Parameter In Type Default Nullable Description
projectIri path string No The IRI of a project. Must be URL-encoded.

Response 200 OK

{
    "keywords": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectKeywordsGetResponse",
    "type": "object",
    "properties": {
        "keywords": {
            "type": "array",
            "items": {
                "type": "string"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

DELETE /admin/projects/shortcode/{projectShortcode}/erase

Description

!ATTENTION! Erase a project with the given shortcode. This will permanently and irrecoverably remove the project and all of its assets. Authorization: Requires system admin permissions. Only available if the feature has been configured on the server side.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectShortcode path string No The shortcode of a project. Must be a 4 digit hexadecimal String.

Response 200 OK

{
    "project": {
        "id": "string",
        "shortname": "string",
        "shortcode": "string",
        "longname": "string",
        "description": [
            {
                "value": "string",
                "language": "string"
            }
        ],
        "keywords": [
            "string"
        ],
        "logo": "string",
        "ontologies": [
            "string"
        ],
        "status": true,
        "selfjoin": true
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectOperationResponseADM",
    "type": "object",
    "required": [
        "project"
    ],
    "properties": {
        "project": {
            "$ref": "#/components/schemas/Project"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/iri/{projectIri}/AllData

Description

Returns all ontologies, data, and configuration belonging to a project identified by the IRI.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectIri path string No The IRI of a project. Must be URL-encoded.

Response 200 OK

"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "type": "string",
    "format": "binary"
}

Response headers

Name Description Schema
Content-Disposition string
Content-Type string

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/iri/{projectIri}/admin-members

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectIri path string No The IRI of a project. Must be URL-encoded.

Response 200 OK

{
    "members": [
        {
            "id": "string",
            "username": "string",
            "email": "string",
            "givenName": "string",
            "familyName": "string",
            "status": true,
            "lang": "string",
            "password": "string",
            "groups": [
                {
                    "id": "string",
                    "name": "string",
                    "descriptions": [
                        {
                            "value": "string",
                            "language": "string"
                        }
                    ],
                    "project": {
                        "id": "string",
                        "shortname": "string",
                        "shortcode": "string",
                        "longname": "string",
                        "description": null,
                        "keywords": [
                            "string"
                        ],
                        "logo": "string",
                        "ontologies": [
                            "string"
                        ],
                        "status": true,
                        "selfjoin": true
                    },
                    "status": true,
                    "selfjoin": true
                }
            ],
            "projects": null,
            "permissions": {
                "groupsPerProject": {},
                "administrativePermissionsPerProject": {}
            }
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectAdminMembersGetResponseADM",
    "type": "object",
    "properties": {
        "members": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/User"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/iri/{projectIri}/members

Description

Returns all project members of a project identified by the IRI.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectIri path string No The IRI of a project. Must be URL-encoded.

Response 200 OK

{
    "members": [
        {
            "id": "string",
            "username": "string",
            "email": "string",
            "givenName": "string",
            "familyName": "string",
            "status": true,
            "lang": "string",
            "password": "string",
            "groups": [
                {
                    "id": "string",
                    "name": "string",
                    "descriptions": [
                        {
                            "value": "string",
                            "language": "string"
                        }
                    ],
                    "project": {
                        "id": "string",
                        "shortname": "string",
                        "shortcode": "string",
                        "longname": "string",
                        "description": null,
                        "keywords": [
                            "string"
                        ],
                        "logo": "string",
                        "ontologies": [
                            "string"
                        ],
                        "status": true,
                        "selfjoin": true
                    },
                    "status": true,
                    "selfjoin": true
                }
            ],
            "projects": null,
            "permissions": {
                "groupsPerProject": {},
                "administrativePermissionsPerProject": {}
            }
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectMembersGetResponseADM",
    "type": "object",
    "properties": {
        "members": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/User"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/shortcode/{projectShortcode}/admin-members

Description

Returns all admin members of a project identified by the shortcode.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectShortcode path string No The shortcode of a project. Must be a 4 digit hexadecimal String.

Response 200 OK

{
    "members": [
        {
            "id": "string",
            "username": "string",
            "email": "string",
            "givenName": "string",
            "familyName": "string",
            "status": true,
            "lang": "string",
            "password": "string",
            "groups": [
                {
                    "id": "string",
                    "name": "string",
                    "descriptions": [
                        {
                            "value": "string",
                            "language": "string"
                        }
                    ],
                    "project": {
                        "id": "string",
                        "shortname": "string",
                        "shortcode": "string",
                        "longname": "string",
                        "description": null,
                        "keywords": [
                            "string"
                        ],
                        "logo": "string",
                        "ontologies": [
                            "string"
                        ],
                        "status": true,
                        "selfjoin": true
                    },
                    "status": true,
                    "selfjoin": true
                }
            ],
            "projects": null,
            "permissions": {
                "groupsPerProject": {},
                "administrativePermissionsPerProject": {}
            }
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectAdminMembersGetResponseADM",
    "type": "object",
    "properties": {
        "members": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/User"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/shortcode/{projectShortcode}/members

Description

Returns all project members of a project identified by the shortcode.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectShortcode path string No The shortcode of a project. Must be a 4 digit hexadecimal String.

Response 200 OK

{
    "members": [
        {
            "id": "string",
            "username": "string",
            "email": "string",
            "givenName": "string",
            "familyName": "string",
            "status": true,
            "lang": "string",
            "password": "string",
            "groups": [
                {
                    "id": "string",
                    "name": "string",
                    "descriptions": [
                        {
                            "value": "string",
                            "language": "string"
                        }
                    ],
                    "project": {
                        "id": "string",
                        "shortname": "string",
                        "shortcode": "string",
                        "longname": "string",
                        "description": null,
                        "keywords": [
                            "string"
                        ],
                        "logo": "string",
                        "ontologies": [
                            "string"
                        ],
                        "status": true,
                        "selfjoin": true
                    },
                    "status": true,
                    "selfjoin": true
                }
            ],
            "projects": null,
            "permissions": {
                "groupsPerProject": {},
                "administrativePermissionsPerProject": {}
            }
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectMembersGetResponseADM",
    "type": "object",
    "properties": {
        "members": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/User"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/shortname/{projectShortname}/admin-members

Description

Returns all admin members of a project identified by the shortname.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectShortname path string No The shortname of a project.

Response 200 OK

{
    "members": [
        {
            "id": "string",
            "username": "string",
            "email": "string",
            "givenName": "string",
            "familyName": "string",
            "status": true,
            "lang": "string",
            "password": "string",
            "groups": [
                {
                    "id": "string",
                    "name": "string",
                    "descriptions": [
                        {
                            "value": "string",
                            "language": "string"
                        }
                    ],
                    "project": {
                        "id": "string",
                        "shortname": "string",
                        "shortcode": "string",
                        "longname": "string",
                        "description": null,
                        "keywords": [
                            "string"
                        ],
                        "logo": "string",
                        "ontologies": [
                            "string"
                        ],
                        "status": true,
                        "selfjoin": true
                    },
                    "status": true,
                    "selfjoin": true
                }
            ],
            "projects": null,
            "permissions": {
                "groupsPerProject": {},
                "administrativePermissionsPerProject": {}
            }
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectAdminMembersGetResponseADM",
    "type": "object",
    "properties": {
        "members": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/User"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/shortname/{projectShortname}/members

Description

Returns all project members of a project identified by the shortname.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectShortname path string No The shortname of a project.

Response 200 OK

{
    "members": [
        {
            "id": "string",
            "username": "string",
            "email": "string",
            "givenName": "string",
            "familyName": "string",
            "status": true,
            "lang": "string",
            "password": "string",
            "groups": [
                {
                    "id": "string",
                    "name": "string",
                    "descriptions": [
                        {
                            "value": "string",
                            "language": "string"
                        }
                    ],
                    "project": {
                        "id": "string",
                        "shortname": "string",
                        "shortcode": "string",
                        "longname": "string",
                        "description": null,
                        "keywords": [
                            "string"
                        ],
                        "logo": "string",
                        "ontologies": [
                            "string"
                        ],
                        "status": true,
                        "selfjoin": true
                    },
                    "status": true,
                    "selfjoin": true
                }
            ],
            "projects": null,
            "permissions": {
                "groupsPerProject": {},
                "administrativePermissionsPerProject": {}
            }
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectMembersGetResponseADM",
    "type": "object",
    "properties": {
        "members": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/User"
            }
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

GET /admin/projects/export

Description

Lists existing exports of all projects.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Response 200 OK

[
    {
        "projectShortcode": "string",
        "location": "string"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/ProjectExportInfoResponse"
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

POST /admin/projects/shortcode/{projectShortcode}/export

Description

Trigger an export of a project identified by the shortcode.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectShortcode path string No The shortcode of a project. Must be a 4 digit hexadecimal String.

Response 202 Accepted

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

POST /admin/projects/shortcode/{projectShortcode}/export-await

Description

Trigger an export of a project identified by the shortcode.Returns the shortcode and the export location when the process has finished successfully.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectShortcode path string No The shortcode of a project. Must be a 4 digit hexadecimal String.

Response 200 OK

{
    "projectShortcode": "string",
    "location": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectExportInfoResponse",
    "type": "object",
    "required": [
        "projectShortcode",
        "location"
    ],
    "properties": {
        "projectShortcode": {
            "type": "string"
        },
        "location": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

POST /admin/projects/shortcode/{projectShortcode}/import

Description

Trigger an import of a project identified by the shortcode.

Input parameters

Parameter In Type Default Nullable Description
httpAuth1 header string N/A No Basic authentication
httpAuth header string N/A No JWT Bearer token
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectShortcode path string No The shortcode of a project. Must be a 4 digit hexadecimal String.

Response 200 OK

{
    "location": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ProjectImportResponse",
    "type": "object",
    "required": [
        "location"
    ],
    "properties": {
        "location": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 401 Unauthorized

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "BadCredentialsException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "ForbiddenException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Admin Store


GET /admin/store/ResetTriplestoreContent

Description

Resets the content of the triplestore, only available if configuration allowReloadOverHttp is set to true.

Input parameters

Parameter In Type Default Nullable Description
prependDefaults query boolean True No Prepend defaults to the data objects.

Request body

[
    {
        "path": "string",
        "name": "string"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/RdfDataObject"
    }
}

Response 200 OK

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "MessageResponse",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

Schema of the response body
{
    "anyOf": [
        {
            "$ref": "#/components/schemas/BadRequestException"
        },
        {
            "$ref": "#/components/schemas/ValidationException"
        },
        {
            "$ref": "#/components/schemas/DuplicateValueException"
        },
        {
            "$ref": "#/components/schemas/GravsearchException"
        }
    ]
}

Response 404 Not Found

{
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "NotFoundException",
    "type": "object",
    "required": [
        "message"
    ],
    "properties": {
        "message": {
            "type": "string"
        }
    }
}

Admin Users


GET /admin/users/iri/{userIri}/project-memberships

Description

Returns the user's project memberships for a user identified by their IRI.

Input parameters

Parameter In Type Default Nullable Description
userIri path string No The user IRI. Must be URL-encoded.

Response 200 OK

{
    "projects": [
        {
            "id": "string",
            "shortname": "string",
            "shortcode": "string",
            "longname": "string",
            "description": [
                {
                    "value": "string",
                    "language": "string"
                }
            ],
            "keywords": [
                "string"
            ],
            "logo": "string",
            "ontologies": [
                "string"
            ],
            "status": true,
            "selfjoin": true
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "title": "UserProjectMembershipsGetResponseADM",
    "type": "object",
    &quo