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.20.0-24-g263e6a4

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 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/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 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}

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. Note that you can provide either a project IRI or a project shortcode.

Input parameters

Parameter In Type Default Nullable Description
projectIri query string No The (optional) IRI of the project.
projectShortcode query string No The (optional) shortcode 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 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/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": 3,
                "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": 224
    },
    "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 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}

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": 71
    },
    "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 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/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 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 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": 298
        }
    ]
}
⚠️ 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": 217
            }
        ]
    }
}
⚠️ 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": 15
                }
            ]
        }
    ]
}
⚠️ 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": 13
            }
        ]
    }
}
⚠️ 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": 250
                }
            ]
        }
    ]
}
⚠️ 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": 26
        }
    ]
}
⚠️ 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": 95
            }
        ]
    }
}
⚠️ 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": 222
        }
    ]
}
⚠️ 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 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

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 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/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 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/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 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}/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 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}/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 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}/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 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/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 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}/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 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/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
keepAssets query boolean False No If set to true the assets in ingest will not be removed.
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 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 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",
    "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 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/users/iri/{userIri}/project-admin-memberships

Description

Returns the user's project admin 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": "UserProjectAdminMembershipsGetResponseADM",
    "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 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/users/iri/{userIri}/group-memberships

Description

Returns the user's group 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

{
    "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
        }
    ]
}
⚠️ 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": "UserGroupMembershipsGetResponseADM",
    "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 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/users

Description

Returns all users.

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

{
    "users": [
        {
            "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": "UsersGetResponseADM",
    "type": "object",
    "properties": {
        "users": {
            "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"
        }
    }
}

POST /admin/users

Description

Create a new user.

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"
    },
    "username": {
        "value": "string"
    },
    "email": {
        "value": "string"
    },
    "givenName": {
        "value": "string"
    },
    "familyName": {
        "value": "string"
    },
    "password": {
        "value": "string"
    },
    "status": {
        "value": true
    },
    "lang": {
        "value": "string"
    },
    "systemAdmin": {
        "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": "UserCreateRequest",
    "type": "object",
    "required": [
        "username",
        "email",
        "givenName",
        "familyName",
        "password",
        "status",
        "lang",
        "systemAdmin"
    ],
    "properties": {
        "id": {
            "$ref": "#/components/schemas/UserIri"
        },
        "username": {
            "$ref": "#/components/schemas/Username"
        },
        "email": {
            "$ref": "#/components/schemas/Email"
        },
        "givenName": {
            "$ref": "#/components/schemas/GivenName"
        },
        "familyName": {
            "$ref": "#/components/schemas/FamilyName"
        },
        "password": {
            "$ref": "#/components/schemas/Password"
        },
        "status": {
            "$ref": "#/components/schemas/UserStatus"
        },
        "lang": {
            "$ref": "#/components/schemas/LanguageCode"
        },
        "systemAdmin": {
            "$ref": "#/components/schemas/SystemAdmin"
        }
    }
}

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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/users/iri/{userIri}

Description

Returns a user identified by their 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
userIri path string No The user IRI. Must be URL-encoded.

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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"
        }
    }
}

DELETE /admin/users/iri/{userIri}

Description

Delete a user identified by IRI (change 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
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
userIri path string No The user IRI. Must be URL-encoded.

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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/users/email/{email}

Description

Returns a user identified by their Email.

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
email path string No The user email. Must be URL-encoded.
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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/users/username/{username}

Description

Returns a user identified by their Username.

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
username path string No The user name. Must be URL-encoded.

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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"
        }
    }
}

POST /admin/users/iri/{userIri}/project-memberships/{projectIri}

Description

Add a user to a project identified by 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.
userIri path string No The user IRI. Must be URL-encoded.

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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"
        }
    }
}

DELETE /admin/users/iri/{userIri}/project-memberships/{projectIri}

Description

Remove a user from a project membership identified by 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.
userIri path string No The user IRI. Must be URL-encoded.

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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"
        }
    }
}

POST /admin/users/iri/{userIri}/project-admin-memberships/{projectIri}

Description

Add a user as an admin to a project identified by 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.
userIri path string No The user IRI. Must be URL-encoded.

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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"
        }
    }
}

DELETE /admin/users/iri/{userIri}/project-admin-memberships/{projectIri}

Description

Remove a user form an admin project membership identified by 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.
userIri path string No The user IRI. Must be URL-encoded.

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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"
        }
    }
}

POST /admin/users/iri/{userIri}/group-memberships/{groupIri}

Description

Add a user to a group identified by 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
groupIri path string No The IRI of a group. Must be URL-encoded.
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
userIri path string No The user IRI. Must be URL-encoded.

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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"
        }
    }
}

DELETE /admin/users/iri/{userIri}/group-memberships/{groupIri}

Description

Remove a user form an group membership identified by 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
groupIri path string No The IRI of a group. Must be URL-encoded.
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
userIri path string No The user IRI. Must be URL-encoded.

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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/users/iri/{userIri}/BasicUserInformation

Description

Update a user's basic information identified by 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
userIri path string No The user IRI. Must be URL-encoded.

Request body

{
    "username": {
        "value": "string"
    },
    "email": {
        "value": "string"
    },
    "givenName": {
        "value": "string"
    },
    "familyName": {
        "value": "string"
    },
    "lang": {
        "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": "BasicUserInformationChangeRequest",
    "type": "object",
    "properties": {
        "username": {
            "$ref": "#/components/schemas/Username"
        },
        "email": {
            "$ref": "#/components/schemas/Email"
        },
        "givenName": {
            "$ref": "#/components/schemas/GivenName"
        },
        "familyName": {
            "$ref": "#/components/schemas/FamilyName"
        },
        "lang": {
            "$ref": "#/components/schemas/LanguageCode"
        }
    }
}

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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/users/iri/{userIri}/Password

Description

Change a user's password identified by 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
userIri path string No The user IRI. Must be URL-encoded.

Request body

{
    "requesterPassword": {
        "value": "string"
    },
    "newPassword": 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": "PasswordChangeRequest",
    "type": "object",
    "required": [
        "requesterPassword",
        "newPassword"
    ],
    "properties": {
        "requesterPassword": {
            "$ref": "#/components/schemas/Password"
        },
        "newPassword": {
            "$ref": "#/components/schemas/Password"
        }
    }
}

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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/users/iri/{userIri}/Status

Description

Change a user's status identified by 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
userIri path string No The user IRI. Must be URL-encoded.

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": "StatusChangeRequest",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/UserStatus"
        }
    }
}

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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/users/iri/{userIri}/SystemAdmin

Description

Change a user's SystemAdmin status identified by 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
userIri path string No The user IRI. Must be URL-encoded.

Request body

{
    "systemAdmin": {
        "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": "SystemAdminChangeRequest",
    "type": "object",
    "required": [
        "systemAdmin"
    ],
    "properties": {
        "systemAdmin": {
            "$ref": "#/components/schemas/SystemAdmin"
        }
    }
}

Response 200 OK

{
    "user": {
        "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": "UserResponseADM",
    "type": "object",
    "required": [
        "user"
    ],
    "properties": {
        "user": {
            "$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"
        }
    }
}

Admin Files


GET /admin/files/{projectShortcode}/{filename}

Description

Returns the permission code and the project's restricted view settings for a given shortcode and filename.

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
filename path string No
KnoraAuthenticationMFYGSLTEMFZWG2BOON3WS43THI2DIMY9 cookie string No
projectShortcode path string No The shortcode of a project. Must be a 4 digit hexadecimal String.

Response 200 OK

{
    "permissionCode": 25,
    "restrictedViewSettings": {
        "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": "PermissionCodeAndProjectRestrictedViewSettings",
    "type": "object",
    "required": [
        "permissionCode"
    ],
    "properties": {
        "permissionCode": {
            "type": "integer",
            "format": "int32"
        },
        "restrictedViewSettings": {
            "$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 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"
        }
    }
}

Schemas

Active

AdministrativePermissionADM

Name Type
forGroup string
forProject string
hasPermissions Array<PermissionADM>
iri string

AdministrativePermissionCreateResponseADM

Name Type
administrativePermission AdministrativePermissionADM

AdministrativePermissionGetResponseADM

Name Type
administrativePermission AdministrativePermissionADM

AdministrativePermissionsForProjectGetResponseADM

Name Type
administrativePermissions Array<AdministrativePermissionADM>

BadCredentialsException

Name Type
message string

BadRequestException

Name Type
message string

BasicUserInformationChangeRequest

Name Type
email Email
familyName FamilyName
givenName GivenName
lang LanguageCode
username Username

CanDeleteListResponseADM

Name Type
canDeleteList boolean
listIri string

CanJoin

CannotJoin

ChangePermissionGroupApiRequestADM

Name Type
forGroup string

ChangePermissionHasPermissionsApiRequestADM

Name Type
hasPermissions Array<PermissionADM>

ChangePermissionPropertyApiRequestADM

Name Type
forProperty string

ChangePermissionResourceClassApiRequestADM

Name Type
forResourceClass string

ChildNodeDeleteResponseADM

Name Type
node ListNodeADM

ChildNodeInfoGetResponseADM

Name Type
nodeinfo ListChildNodeInfoADM

Comments

Name Type
value Array<StringLiteralV2>

CreateAdministrativePermissionAPIRequestADM

Name Type
forGroup string
forProject string
hasPermissions Array<PermissionADM>
id string

CreateDefaultObjectAccessPermissionAPIRequestADM

Name Type
forGroup string
forProject string
forProperty string
forResourceClass string
hasPermissions Array<PermissionADM>
id string

DefaultObjectAccessPermissionADM

Name Type
forGroup string
forProject string
forProperty string
forResourceClass string
hasPermissions Array<PermissionADM>
iri string

DefaultObjectAccessPermissionCreateResponseADM

Name Type
defaultObjectAccessPermission DefaultObjectAccessPermissionADM

DefaultObjectAccessPermissionGetResponseADM

Name Type
defaultObjectAccessPermission DefaultObjectAccessPermissionADM

DefaultObjectAccessPermissionsForProjectGetResponseADM

Name Type
defaultObjectAccessPermissions Array<DefaultObjectAccessPermissionADM>

Description

Name Type
value StringLiteralV2

DuplicateValueException

Name Type
message string

Email

Name Type
value string

FamilyName

Name Type
value string

ForbiddenException

Name Type
message string

GivenName

Name Type
value string

GravsearchException

Name Type
message string

Group

Name Type
descriptions Array<StringLiteralV2>
id string
name string
project Project
selfjoin boolean
status boolean

GroupCreateRequest

Name Type
descriptions GroupDescriptions
id GroupIri
name GroupName
project ProjectIri
selfjoin GroupSelfJoin
status GroupStatus

GroupDescriptions

Name Type
value Array<StringLiteralV2>

GroupGetResponseADM

Name Type
group Group

GroupIri

Name Type
value string

GroupMembersGetResponseADM

Name Type
members Array<User>

GroupName

Name Type
value string

GroupSelfJoin

Name Type
value boolean

GroupsGetResponseADM

Name Type
groups Array<Group>

GroupStatus

Name Type
value boolean

GroupStatusUpdateRequest

Name Type
status GroupStatus

GroupUpdateRequest

Name Type
descriptions GroupDescriptions
name GroupName
selfjoin GroupSelfJoin
status GroupStatus

Inactive

Keyword

Name Type
value string

Labels

Name Type
value Array<StringLiteralV2>

LanguageCode

Name Type
value string

ListADM

Name Type
children Array<ListChildNodeADM>
listinfo ListRootNodeInfoADM

ListChangeCommentsRequest

Name Type
comments Comments

ListChangeLabelsRequest

Name Type
labels Labels

ListChangeNameRequest

Name Type
name ListName

ListChangePositionRequest

Name Type
parentNodeIri ListIri
position Position

ListChangeRequest

Name Type
comments Comments
hasRootNode ListIri
labels Labels
listIri ListIri
name ListName
position Position
projectIri ProjectIri

ListChildNodeADM

Name Type
children Array<ListChildNodeADM>
comments StringLiteralSequenceV2
hasRootNode string
id string
labels StringLiteralSequenceV2
name string
position integer(int32)

ListChildNodeInfoADM

Name Type
comments StringLiteralSequenceV2
hasRootNode string
id string
labels StringLiteralSequenceV2
name string
position integer(int32)

ListCreateRootNodeRequest

Name Type
comments Comments
id ListIri
labels Labels
name ListName
projectIri ProjectIri

ListDeleteResponseADM

Name Type
deleted boolean
iri string

ListGetResponseADM

Name Type
list ListADM

ListIri

Name Type
value string

ListItemDeleteResponseADM

Type:

ListItemGetResponseADM

Type:

ListName

Name Type
value string

ListNodeADM

Type:

ListNodeCommentsDeleteResponseADM

Name Type
commentsDeleted boolean
nodeIri string

ListNodeGetResponseADM

Name Type
node NodeADM

ListRootNodeADM

Name Type
children Array<ListChildNodeADM>
comments StringLiteralSequenceV2
id string
isRootNode boolean
labels StringLiteralSequenceV2
name string
projectIri string

ListRootNodeInfoADM

Name Type
comments StringLiteralSequenceV2
id string
isRootNode boolean
labels StringLiteralSequenceV2
name string
projectIri string

ListsGetResponseADM

Name Type
lists Array<ListRootNodeInfoADM>
Name Type
value string

Longname

Name Type
value string

Map_Seq_IRI

Map_Set_PermissionADM

MessageResponse

Name Type
message string

NodeADM

Name Type
children Array<ListChildNodeADM>
nodeinfo ListChildNodeInfoADM

NodeInfoGetResponseADM

Type:

NodePositionChangeResponseADM

Name Type
node ListNodeADM

NotFoundException

Name Type
message string

Password

Name Type
value string

PasswordChangeRequest

Name Type
newPassword Password
requesterPassword Password

PermissionADM

Name Type
additionalInformation string
name string
permissionCode integer(int32)

PermissionCodeAndProjectRestrictedViewSettings

Name Type
permissionCode integer(int32)
restrictedViewSettings ProjectRestrictedViewSettingsADM

PermissionDeleteResponseADM

Name Type
deleted boolean
permissionIri string

PermissionGetResponseADM

Type:

PermissionInfoADM

Name Type
iri string
permissionType string

PermissionsDataADM

Name Type
administrativePermissionsPerProject Map_Set_PermissionADM
groupsPerProject Map_Seq_IRI

PermissionsForProjectGetResponseADM

Name Type
permissions Array<PermissionInfoADM>

Position

Name Type
value integer(int32)

Project

Name Type
description Array<StringLiteralV2>
id string
keywords Array<string>
logo string
longname string
ontologies Array<string>
selfjoin boolean
shortcode string
shortname string
status boolean

ProjectAdminMembersGetResponseADM

Name Type
members Array<User>

ProjectCreateRequest

Name Type
description Array<Description>
id ProjectIri
keywords Array<Keyword>
logo Logo
longname Longname
selfjoin SelfJoin
shortcode Shortcode
shortname Shortname
status Status

ProjectExportInfoResponse

Name Type
location string
projectShortcode string

ProjectGetResponse

Name Type
project Project

ProjectImportResponse

Name Type
location string

ProjectIri

Name Type
value string

ProjectKeywordsGetResponse

Name Type
keywords Array<string>

ProjectMembersGetResponseADM

Name Type
members Array<User>

ProjectOperationResponseADM

Name Type
project Project

ProjectRestrictedViewSettingsADM

Name Type
size string
watermark boolean

ProjectRestrictedViewSettingsGetResponseADM

Name Type
settings ProjectRestrictedViewSettingsADM

ProjectsGetResponse

Name Type
projects Array<Project>

ProjectsKeywordsGetResponse

Name Type
keywords Array<string>

ProjectUpdateRequest

Name Type
description Array<Description>
keywords Array<Keyword>
logo Logo
longname Longname
selfjoin SelfJoin
shortname Shortname
status Status

RdfDataObject

Name Type
name string
path string

RestrictedViewResponse

Name Type
size Size
watermark Watermark

RootNodeInfoGetResponseADM

Name Type
listinfo ListRootNodeInfoADM

SelfJoin

Type:

SetRestrictedViewRequest

Name Type
size Size
watermark Watermark

Shortcode

Name Type
value string

Shortname

Name Type
value string

Size

Name Type
value string

Status

Type:

StatusChangeRequest

Name Type
status UserStatus

StringLiteralSequenceV2

Name Type
stringLiterals Array<StringLiteralV2>

StringLiteralV2

Name Type
language string
value string

SystemAdmin

Name Type
value boolean

SystemAdminChangeRequest

Name Type
systemAdmin SystemAdmin

User

Name Type
email string
familyName string
givenName string
groups Array<Group>
id string
lang string
password string
permissions PermissionsDataADM
projects Array<Project>
status boolean
username string

UserCreateRequest

Name Type
email Email
familyName FamilyName
givenName GivenName
id UserIri
lang LanguageCode
password Password
status UserStatus
systemAdmin SystemAdmin
username Username

UserGroupMembershipsGetResponseADM

Name Type
groups Array<Group>

UserIri

Name Type
value string

Username

Name Type
value string

UserProjectAdminMembershipsGetResponseADM

Name Type
projects Array<Project>

UserProjectMembershipsGetResponseADM

Name Type
projects Array<Project>

UserResponseADM

Name Type
user User

UsersGetResponseADM

Name Type
users Array<User>

UserStatus

Name Type
value boolean

ValidationException

Name Type
msg string

Watermark

Name Type
value boolean

Security schemes

Name Type Scheme Description
httpAuth http bearer
httpAuth1 http basic