Umbraco-CMS
GitHubUmbraco is a free and open source .NET content management system helping you deliver delightful digital experiences.
Umbraco Management API Specification
Located in src/Umbraco.Cms.Api.Management/OpenApi.json on branch HEAD
3.1.1
JSON
428 Endpoints
1470.9 KB
Operations & Route Endpoints (100)
Raw JSON Specification
{
"openapi": "3.1.1",
"info": {
"title": "Umbraco Management API",
"description": "This shows all APIs available in this version of Umbraco - including all the legacy apis that are available for backward compatibility",
"version": "Latest"
},
"paths": {
"/umbraco/management/api/v1/culture": {
"get": {
"tags": [
"Culture"
],
"summary": "Gets a paginated collection of cultures available for creating languages.",
"description": "Gets a paginated collection containing the English and localized names of all available cultures.",
"operationId": "GetCulture",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedCultureReponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type": {
"post": {
"tags": [
"Data Type"
],
"summary": "Creates a new data type.",
"description": "Creates a new data type with the configuration specified in the request model.",
"operationId": "PostDataType",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDataTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type/{id}": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets a data type.",
"description": "Gets a data type identified by the provided Id.",
"operationId": "GetDataTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataTypeResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Data Type"
],
"summary": "Deletes a data type.",
"description": "Deletes a data type identified by the provided Id.",
"operationId": "DeleteDataTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Data Type"
],
"summary": "Updates a data type.",
"description": "Updates a data type identified by the provided Id with the details from the request model.",
"operationId": "PutDataTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDataTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type/{id}/copy": {
"post": {
"tags": [
"Data Type"
],
"summary": "Copies a data type.",
"description": "Creates a duplicate of an existing data type identified by the provided unique Id. The copied data type will be given a new Id and have ' (copy)' appended to its name. Optionally, the copy can be placed in a specific container by providing a target container Id.",
"operationId": "PostDataTypeByIdCopy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CopyDataTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type/{id}/is-used": {
"get": {
"tags": [
"Data Type"
],
"summary": "Checks if a data type is used.",
"description": "Checks if the data type identified by the provided Id is used in any content, media, or member types.",
"operationId": "GetDataTypeByIdIsUsed",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type/{id}/move": {
"put": {
"tags": [
"Data Type"
],
"summary": "Moves a data type.",
"description": "Moves an existing data type identified by Id to a different container. The target container Id must be provided in the request model.",
"operationId": "PutDataTypeByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveDataTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type/{id}/referenced-by": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets a paged collection of entities that are referenced by a data type.",
"description": "Gets a paged collection of entities that are referenced by the data type with the provided Id, so you can see where it is being used.",
"operationId": "GetDataTypeByIdReferencedBy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type/{id}/schema": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetDataTypeByIdSchema",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataTypeSchemaResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type/batch": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets multiple data types.",
"description": "Gets multiple data types identified by the provided Ids.",
"operationId": "GetDataTypeBatch",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseModelDataTypeResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type/configuration": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets the data type configuration.",
"description": "Gets the configuration settings for data types.",
"operationId": "GetDataTypeConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatatypeConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type/folder": {
"post": {
"tags": [
"Data Type"
],
"summary": "Creates a data type folder.",
"description": "Creates a new data type folder with the provided name and parent location.",
"operationId": "PostDataTypeFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFolderRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type/folder/{id}": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets a data type folder.",
"description": "Gets a data type folder identified by the provided Id.",
"operationId": "GetDataTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Data Type"
],
"summary": "Deletes a data type folder.",
"description": "Deletes a data type folder identified by the provided Id.",
"operationId": "DeleteDataTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Data Type"
],
"summary": "Updates a data type folder.",
"description": "Updates a data type folder identified by the provided Id with the details provided in the request model.",
"operationId": "PutDataTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFolderResponseModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/data-type/schemas/batch": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetDataTypeSchemasBatch",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FetchResponseModelDataTypeSchemaItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/filter/data-type": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets a filtered collection of data types.",
"description": "Filters data types based on the provided criteria with support for pagination.",
"operationId": "GetFilterDataType",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "name",
"in": "query",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "editorUiAlias",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "editorAlias",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDataTypeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/data-type": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets a collection of data type items.",
"description": "Gets a collection of data type items identified by the provided Ids.",
"operationId": "GetItemDataType",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/data-type/ancestors": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets ancestors for a collection of data type items.",
"description": "Gets the ancestor chains for data type items identified by the provided Ids.",
"operationId": "GetItemDataTypeAncestors",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemAncestorsResponseModelNamedItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/data-type/search": {
"get": {
"tags": [
"Data Type"
],
"summary": "Searches data type items.",
"description": "Searches data type items by the provided query with pagination support.",
"operationId": "GetItemDataTypeSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedModelDataTypeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/data-type/ancestors": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets a collection of ancestor data type folders.",
"description": "Gets a collection of data type folders that are ancestors to the provided Id.",
"operationId": "GetTreeDataTypeAncestors",
"parameters": [
{
"name": "descendantId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypeTreeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/data-type/children": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets a collection of data type tree child items.",
"description": "Gets a paginated collection of data type tree items that are children of the provided parent Id.",
"operationId": "GetTreeDataTypeChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDataTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/data-type/root": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets a collection of data type items from the root of the tree.",
"description": "Gets a paginated collection of data type items from the root of the tree with optional filtering.",
"operationId": "GetTreeDataTypeRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDataTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/data-type/search": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetTreeDataTypeSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "itemKind",
"in": "query",
"schema": {
"default": "All",
"$ref": "#/components/schemas/TreeItemKindModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDataTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/data-type/siblings": {
"get": {
"tags": [
"Data Type"
],
"summary": "Gets a collection of data type tree sibling items.",
"description": "Gets a paged collection of data type tree items that are siblings of the provided Id. The collection can be optionally filtered to return only folder, or folders and data types.",
"operationId": "GetTreeDataTypeSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetDataTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/dictionary": {
"get": {
"tags": [
"Dictionary"
],
"summary": "Gets a paginated collection of dictionary items.",
"description": "Gets a paginated collection of dictionary items with optional filtering by name.",
"operationId": "GetDictionary",
"parameters": [
{
"name": "filter",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDictionaryOverviewResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"Dictionary"
],
"summary": "Creates a new dictionary.",
"description": "Creates a new dictionary with the configuration specified in the request model.",
"operationId": "PostDictionary",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDictionaryItemRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/dictionary/{id}": {
"get": {
"tags": [
"Dictionary"
],
"summary": "Gets a dictionary.",
"description": "Gets a dictionary identified by the provided Id.",
"operationId": "GetDictionaryById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DictionaryItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Dictionary"
],
"summary": "Deletes a dictionary.",
"description": "Deletes a dictionary identified by the provided Id.",
"operationId": "DeleteDictionaryById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Dictionary"
],
"summary": "Updates a dictionary.",
"description": "Updates a dictionary identified by the provided Id with the details from the request model.",
"operationId": "PutDictionaryById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDictionaryItemRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/dictionary/{id}/export": {
"get": {
"tags": [
"Dictionary"
],
"summary": "Exports a dictionary.",
"description": "Exports the dictionary identified by the provided Id to a downloadable format.",
"operationId": "GetDictionaryByIdExport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "includeChildren",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/dictionary/{id}/move": {
"put": {
"tags": [
"Dictionary"
],
"summary": "Moves a dictionary.",
"description": "Moves a dictionary identified by the provided Id to a different location.",
"operationId": "PutDictionaryByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveDictionaryRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/dictionary/import": {
"post": {
"tags": [
"Dictionary"
],
"summary": "Imports a dictionary.",
"description": "Imports a dictionary from the provided file upload.",
"operationId": "PostDictionaryImport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportDictionaryRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/dictionary": {
"get": {
"tags": [
"Dictionary"
],
"summary": "Gets a collection of dictionary items.",
"description": "Gets a collection of dictionary items identified by the provided Ids.",
"operationId": "GetItemDictionary",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryItemItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/dictionary/ancestors": {
"get": {
"tags": [
"Dictionary"
],
"summary": "Gets a collection of ancestor dictionary items.",
"description": "Gets a collection of dictionary items that are ancestors to the provided Id.",
"operationId": "GetTreeDictionaryAncestors",
"parameters": [
{
"name": "descendantId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NamedEntityTreeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/dictionary/children": {
"get": {
"tags": [
"Dictionary"
],
"summary": "Gets a collection of dictionary tree child items.",
"description": "Gets a paginated collection of dictionary tree items that are children of the provided parent Id.",
"operationId": "GetTreeDictionaryChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedNamedEntityTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/dictionary/root": {
"get": {
"tags": [
"Dictionary"
],
"summary": "Gets a collection of dictionary items from the root of the tree.",
"description": "Gets a paginated collection of dictionary items from the root of the tree with optional filtering.",
"operationId": "GetTreeDictionaryRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedNamedEntityTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1.1/document/{id}/validate": {
"put": {
"tags": [
"Document"
],
"summary": "Validates updating a document.",
"description": "Validates the request model for updating a document without actually updating it.",
"operationId": "PutDocumentByIdValidate",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateUpdateDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/collection/document/{id}": {
"get": {
"tags": [
"Document"
],
"summary": "Gets a document collection.",
"description": "Gets a document collection identified by the provided Id.",
"operationId": "GetCollectionDocumentById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "orderBy",
"in": "query",
"schema": {
"type": "string",
"default": "updateDate"
}
},
{
"name": "orderCulture",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "orderDirection",
"in": "query",
"schema": {
"default": "Ascending",
"$ref": "#/components/schemas/DirectionModel"
}
},
{
"name": "filter",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentCollectionResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document": {
"post": {
"tags": [
"Document"
],
"summary": "Creates a new document.",
"description": "Creates a new document with the configuration specified in the request model.",
"operationId": "PostDocument",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}": {
"get": {
"tags": [
"Document"
],
"summary": "Gets a document.",
"description": "Gets a document identified by the provided Id.",
"operationId": "GetDocumentById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Document"
],
"summary": "Deletes a document.",
"description": "Deletes a document identified by the provided Id.",
"operationId": "DeleteDocumentById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Document"
],
"summary": "Updates a document.",
"description": "Updates a document identified by the provided Id with the details from the request model.",
"operationId": "PutDocumentById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/audit-log": {
"get": {
"tags": [
"Document"
],
"summary": "Gets the audit log for a document.",
"description": "Gets a paginated collection of audit log entries for the document identified by the provided Id.",
"operationId": "GetDocumentByIdAuditLog",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "orderDirection",
"in": "query",
"schema": {
"default": "Descending",
"$ref": "#/components/schemas/DirectionModel"
}
},
{
"name": "sinceDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAuditLogResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/available-segment-options": {
"get": {
"tags": [
"Document"
],
"summary": "Gets available segments.",
"description": "Gets a collection of available content segments for the system.",
"operationId": "GetDocumentByIdAvailableSegmentOptions",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedSegmentResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/copy": {
"post": {
"tags": [
"Document"
],
"summary": "Copies a document.",
"description": "Creates a duplicate of an existing document identified by the provided Id.",
"operationId": "PostDocumentByIdCopy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CopyDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/domains": {
"get": {
"tags": [
"Document"
],
"summary": "Gets domains for a document.",
"description": "Gets the domains and culture settings assigned to the document identified by the provided Id.",
"operationId": "GetDocumentByIdDomains",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainsResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Document"
],
"summary": "Updates the domains for a document.",
"description": "Updates the domains for the document identified by the provided Id with the details from the request model.",
"operationId": "PutDocumentByIdDomains",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainsRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/move": {
"put": {
"tags": [
"Document"
],
"summary": "Moves a document.",
"description": "Moves a document identified by the provided Id to a different location.",
"operationId": "PutDocumentByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/move-to-recycle-bin": {
"put": {
"tags": [
"Document"
],
"summary": "Moves a document to the recycle bin.",
"description": "Moves a document identified by the provided Id to the recycle bin.",
"operationId": "PutDocumentByIdMoveToRecycleBin",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/notifications": {
"get": {
"tags": [
"Document"
],
"summary": "Gets notifications for a document.",
"description": "Gets the notifications for the document identified by the provided Id.",
"operationId": "GetDocumentByIdNotifications",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentNotificationResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Document"
],
"summary": "Updates notification subscriptions for a document.",
"description": "Updates which actions the current user is subscribed to receive notifications for on the specified document.",
"operationId": "PutDocumentByIdNotifications",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocumentNotificationsRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/patch": {
"patch": {
"tags": [
"Document"
],
"summary": "Make partial updates to a document. For more information, see the documentation at https://docs.umbraco.com/umbraco-cms/reference/management-api/patching/document-endpoint-guide or https://docs.umbraco.com/umbraco-cms/reference/management-api/patching/document-endpoint-spec",
"operationId": "PatchDocumentByIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PatchDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/preview-url": {
"get": {
"tags": [
"Document"
],
"summary": "Gets the preview URL for a document.",
"description": "Gets the preview URL for the document identified by the provided Id.",
"operationId": "GetDocumentByIdPreviewUrl",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "providerAlias",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "segment",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentUrlInfoModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/public-access": {
"post": {
"tags": [
"Document"
],
"summary": "Creates public access rules for a document.",
"description": "Creates public access protection for the document identified by the provided Id.",
"operationId": "PostDocumentByIdPublicAccess",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicAccessRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Document"
],
"summary": "Removes public access settings for a document.",
"description": "Removes public access protection/rules for the document identified by the provided Id.",
"operationId": "DeleteDocumentByIdPublicAccess",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"get": {
"tags": [
"Document"
],
"summary": "Gets public access rules for a document.",
"description": "Gets the public access protection settings for the document identified by the provided Id.",
"operationId": "GetDocumentByIdPublicAccess",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "includeAncestors",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicAccessResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Document"
],
"summary": "Updates public access protection for a document.",
"description": "Updates the member protection settings for a document, controlling which members or member groups can access it.",
"operationId": "PutDocumentByIdPublicAccess",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicAccessRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/publish": {
"put": {
"tags": [
"Document"
],
"summary": "Publishes a document.",
"description": "Publishes a document identified by the provided Id.",
"operationId": "PutDocumentByIdPublish",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/publish-with-descendants": {
"put": {
"tags": [
"Document"
],
"summary": "Publishes a document with its descendants.",
"description": "Publishes a document and its descendants identified by the provided Id.",
"operationId": "PutDocumentByIdPublishWithDescendants",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishDocumentWithDescendantsRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishWithDescendantsResultModel"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/publish-with-descendants/result/{taskId}": {
"get": {
"tags": [
"Document"
],
"summary": "Gets the result of publishing a document with descendants.",
"description": "Gets the status and result of a publish with descendants operation.",
"operationId": "GetDocumentByIdPublishWithDescendantsResultByTaskId",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "taskId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishWithDescendantsResultModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/published": {
"get": {
"tags": [
"Document"
],
"summary": "Gets a document.",
"description": "Gets a document identified by the provided Id.",
"operationId": "GetDocumentByIdPublished",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishedDocumentResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/referenced-by": {
"get": {
"tags": [
"Document"
],
"summary": "Gets a collection of items that reference documents.",
"description": "Gets a paginated collection of items that reference the documents identified by the provided Ids.",
"operationId": "GetDocumentByIdReferencedBy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/referenced-descendants": {
"get": {
"tags": [
"Document"
],
"summary": "Gets document descendants that are referenced.",
"description": "Gets a paginated collection of descendant documents that are referenced by other content.",
"operationId": "GetDocumentByIdReferencedDescendants",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedReferenceByIdModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/sort-children": {
"put": {
"tags": [
"Document"
],
"summary": "Sorts the children of a document by a field.",
"description": "Sorts the children of the specified parent document by a system field in the given direction. When sorting by name, an optional culture selects the variant name; the culture is not validated, so children that do not vary by it (or an unrecognised culture) fall back to the invariant name.",
"operationId": "PutDocumentByIdSortChildren",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortDocumentChildrenByFieldRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/unpublish": {
"put": {
"tags": [
"Document"
],
"summary": "Unpublishes a document.",
"description": "Unpublishes a document identified by the provided Id.",
"operationId": "PutDocumentByIdUnpublish",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnpublishDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/{id}/update-and-publish": {
"put": {
"tags": [
"Document"
],
"summary": "Updates and publishes a document.",
"description": "Updates and publishes a document identified by the provided Id with the details from the request model.",
"operationId": "PutDocumentByIdUpdateAndPublish",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAndPublishDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/are-referenced": {
"get": {
"tags": [
"Document"
],
"summary": "Gets a collection of items that reference documents.",
"description": "Gets a paginated collection of items that reference the documents identified by the provided Ids.",
"operationId": "GetDocumentAreReferenced",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedReferenceByIdModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/configuration": {
"get": {
"tags": [
"Document"
],
"summary": "Gets the document configuration.",
"description": "Gets the configuration settings for documents.",
"operationId": "GetDocumentConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/create-and-publish": {
"post": {
"tags": [
"Document"
],
"summary": "Creates and publishes a new document.",
"description": "Creates and publishes a new document with the configuration specified in the request model.",
"operationId": "PostDocumentCreateAndPublish",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAndPublishDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/root/sort-children": {
"put": {
"tags": [
"Document"
],
"summary": "Sorts the root-level documents by a field.",
"description": "Sorts the root-level documents by a system field in the given direction. When sorting by name, an optional culture selects the variant name; the culture is not validated, so documents that do not vary by it (or an unrecognised culture) fall back to the invariant name.",
"operationId": "PutDocumentRootSortChildren",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortDocumentChildrenByFieldRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/sort": {
"put": {
"tags": [
"Document"
],
"summary": "Sorts documents.",
"description": "Sorts documents in the specified parent container according to the provided sort order.",
"operationId": "PutDocumentSort",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortingRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/urls": {
"get": {
"tags": [
"Document"
],
"summary": "Gets URLs for a document.",
"description": "Gets the URLs for the document identified by the provided Id.",
"operationId": "GetDocumentUrls",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentUrlInfoResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document/validate": {
"post": {
"tags": [
"Document"
],
"summary": "Validates creating a document.",
"description": "Validates the request model for creating a new document without actually creating it.",
"operationId": "PostDocumentValidate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/document": {
"get": {
"tags": [
"Document"
],
"summary": "Gets a collection of document items.",
"description": "Gets a collection of document items identified by the provided Ids.",
"operationId": "GetItemDocument",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/document/ancestors": {
"get": {
"tags": [
"Document"
],
"summary": "Gets ancestors for a collection of document items.",
"description": "Gets the ancestor chains for document items identified by the provided Ids.",
"operationId": "GetItemDocumentAncestors",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemAncestorsResponseModelDocumentItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/document/search": {
"get": {
"tags": [
"Document"
],
"summary": "Searches document items.",
"description": "Searches document items by the provided query with pagination support.",
"operationId": "GetItemDocumentSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "trashed",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "allowedDocumentTypes",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedModelDocumentItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/document": {
"delete": {
"tags": [
"Document"
],
"summary": "Empties the document recycle bin.",
"description": "Permanently deletes all documents in the recycle bin. This operation cannot be undone.",
"operationId": "DeleteRecycleBinDocument",
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/document/{id}": {
"delete": {
"tags": [
"Document"
],
"summary": "Deletes a document.",
"description": "Deletes a document identified by the provided Id.",
"operationId": "DeleteRecycleBinDocumentById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/document/{id}/original-parent": {
"get": {
"tags": [
"Document"
],
"summary": "Gets the original parent of a document in the recycle bin.",
"description": "Gets the original parent location of a document before it was moved to the recycle bin.",
"operationId": "GetRecycleBinDocumentByIdOriginalParent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/document/{id}/restore": {
"put": {
"tags": [
"Document"
],
"summary": "Restores a document from the recycle bin.",
"description": "Restores a document from the recycle bin to its original location or a specified parent.",
"operationId": "PutRecycleBinDocumentByIdRestore",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveMediaRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/document/children": {
"get": {
"tags": [
"Document"
],
"summary": "Gets a collection of documents in the recycle bin.",
"description": "Gets a paginated collection of documents that are children of the provided parent in the recycle bin.",
"operationId": "GetRecycleBinDocumentChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentRecycleBinItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/document/referenced-by": {
"get": {
"tags": [
"Document"
],
"summary": "Gets items referencing a document in the recycle bin.",
"description": "Gets a paginated collection of items that reference the document in the recycle bin.",
"operationId": "GetRecycleBinDocumentReferencedBy",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/document/root": {
"get": {
"tags": [
"Document"
],
"summary": "Gets documents at the root of the recycle bin.",
"description": "Gets a paginated collection of documents at the root level of the recycle bin.",
"operationId": "GetRecycleBinDocumentRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentRecycleBinItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/document/siblings": {
"get": {
"tags": [
"Document"
],
"summary": "Gets sibling documents in the recycle bin.",
"description": "Gets a collection of sibling documents in the recycle bin at the same level as the provided Id.",
"operationId": "GetRecycleBinDocumentSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetDocumentRecycleBinItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document/ancestors": {
"get": {
"tags": [
"Document"
],
"summary": "Gets a collection of ancestor document items.",
"description": "Gets a collection of document items that are ancestors to the provided Id.",
"operationId": "GetTreeDocumentAncestors",
"parameters": [
{
"name": "descendantId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTreeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document/children": {
"get": {
"tags": [
"Document"
],
"summary": "Gets a collection of document tree child items.",
"description": "Gets a paginated collection of document tree items that are children of the provided parent Id.",
"operationId": "GetTreeDocumentChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document/root": {
"get": {
"tags": [
"Document"
],
"summary": "Gets a collection of document items from the root of the tree.",
"description": "Gets a paginated collection of document items from the root of the tree with optional filtering.",
"operationId": "GetTreeDocumentRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document/siblings": {
"get": {
"tags": [
"Document"
],
"summary": "Gets a collection of document tree sibling items.",
"description": "Gets a collection of document tree items that are siblings of the provided Id.",
"operationId": "GetTreeDocumentSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetDocumentTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-blueprint": {
"post": {
"tags": [
"Document Blueprint"
],
"summary": "Creates a new document blueprint.",
"description": "Creates a new document blueprint with the configuration specified in the request model.",
"operationId": "PostDocumentBlueprint",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentBlueprintRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-blueprint/{id}": {
"get": {
"tags": [
"Document Blueprint"
],
"summary": "Gets a document blueprint.",
"description": "Gets a document blueprint identified by the provided Id.",
"operationId": "GetDocumentBlueprintById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentBlueprintResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Document Blueprint"
],
"summary": "Deletes a document blueprint.",
"description": "Deletes a document blueprint identified by the provided Id.",
"operationId": "DeleteDocumentBlueprintById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Document Blueprint"
],
"summary": "Updates a document blueprint.",
"description": "Updates a document blueprint identified by the provided Id with the details from the request model.",
"operationId": "PutDocumentBlueprintById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocumentBlueprintRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-blueprint/{id}/audit-log": {
"get": {
"tags": [
"Document Blueprint"
],
"summary": "Gets the audit log for a document blueprint.",
"description": "Gets a paginated collection of audit log entries for the document blueprint identified by the provided Id.",
"operationId": "GetDocumentBlueprintByIdAuditLog",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "orderDirection",
"in": "query",
"schema": {
"default": "Descending",
"$ref": "#/components/schemas/DirectionModel"
}
},
{
"name": "sinceDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAuditLogResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-blueprint/{id}/move": {
"put": {
"tags": [
"Document Blueprint"
],
"summary": "Moves a document blueprint.",
"description": "Moves a document blueprint identified by the provided Id to a different location.",
"operationId": "PutDocumentBlueprintByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveDocumentBlueprintRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-blueprint/{id}/scaffold": {
"get": {
"tags": [
"Document Blueprint"
],
"summary": "Scaffolds a document blueprint.",
"description": "Creates a scaffold for a new document blueprint with default values.",
"operationId": "GetDocumentBlueprintByIdScaffold",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentBlueprintResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-blueprint/folder": {
"post": {
"tags": [
"Document Blueprint"
],
"summary": "Creates a document blueprint folder.",
"description": "Creates a new document blueprint folder with the provided name and parent location.",
"operationId": "PostDocumentBlueprintFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFolderRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-blueprint/folder/{id}": {
"get": {
"tags": [
"Document Blueprint"
],
"summary": "Gets a document blueprint folder.",
"description": "Gets a document blueprint folder identified by the provided Id.",
"operationId": "GetDocumentBlueprintFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Document Blueprint"
],
"summary": "Deletes a document blueprint folder.",
"description": "Deletes a document blueprint folder identified by the provided Id.",
"operationId": "DeleteDocumentBlueprintFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Document Blueprint"
],
"summary": "Updates a document blueprint folder.",
"description": "Updates a document blueprint folder identified by the provided Id with the details from the request model.",
"operationId": "PutDocumentBlueprintFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFolderResponseModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-blueprint/from-document": {
"post": {
"tags": [
"Document Blueprint"
],
"summary": "Creates a document blueprint from an existing document.",
"description": "Creates a new document blueprint based on an existing document identified by the provided Id.",
"operationId": "PostDocumentBlueprintFromDocument",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentBlueprintFromDocumentRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/document-blueprint": {
"get": {
"tags": [
"Document Blueprint"
],
"summary": "Gets a collection of document blueprint items.",
"description": "Gets a collection of document blueprint items identified by the provided Ids.",
"operationId": "GetItemDocumentBlueprint",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentBlueprintItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document-blueprint/ancestors": {
"get": {
"tags": [
"Document Blueprint"
],
"summary": "Gets a collection of ancestor document blueprint items.",
"description": "Gets a collection of document blueprint items that are ancestors to the provided Id.",
"operationId": "GetTreeDocumentBlueprintAncestors",
"parameters": [
{
"name": "descendantId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentBlueprintTreeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document-blueprint/children": {
"get": {
"tags": [
"Document Blueprint"
],
"summary": "Gets a collection of document blueprint tree child items.",
"description": "Gets a paginated collection of document blueprint tree items that are children of the provided parent Id.",
"operationId": "GetTreeDocumentBlueprintChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentBlueprintTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document-blueprint/root": {
"get": {
"tags": [
"Document Blueprint"
],
"summary": "Gets a collection of document blueprint items from the root of the tree.",
"description": "Gets a paginated collection of document blueprint items from the root of the tree with optional filtering.",
"operationId": "GetTreeDocumentBlueprintRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentBlueprintTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document-blueprint/siblings": {
"get": {
"tags": [
"Document Blueprint"
],
"summary": "Gets a collection of document blueprint tree sibling items.",
"description": "Gets a collection of document blueprint tree items that are siblings of the provided Id.",
"operationId": "GetTreeDocumentBlueprintSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetDocumentBlueprintTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type": {
"post": {
"tags": [
"Document Type"
],
"summary": "Creates a new document type.",
"description": "Creates a new document type with the configuration specified in the request model.",
"operationId": "PostDocumentType",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets a document type.",
"description": "Gets a document type identified by the provided Id.",
"operationId": "GetDocumentTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentTypeResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Document Type"
],
"summary": "Deletes a document type.",
"description": "Deletes a document type identified by the provided Id.",
"operationId": "DeleteDocumentTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Document Type"
],
"summary": "Updates a document type.",
"description": "Updates a document type identified by the provided Id with the details from the request model.",
"operationId": "PutDocumentTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocumentTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}/allowed-children": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets allowed child document types.",
"description": "Gets a collection of document types that are allowed as children of the specified parent document type.",
"operationId": "GetDocumentTypeByIdAllowedChildren",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "parentContentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAllowedDocumentTypeModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}/allowed-parents": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets allowed parent document types.",
"description": "Gets a collection of document types that are allowed as parents of the specified document type.",
"operationId": "GetDocumentTypeByIdAllowedParents",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentTypeAllowedParentsResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}/blueprint": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets document blueprints for a document type.",
"description": "Gets a collection of document blueprints available for the specified document type.",
"operationId": "GetDocumentTypeByIdBlueprint",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentTypeBlueprintItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}/composition-references": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets composition references.",
"description": "Gets a collection of document types that reference the specified document type as a composition.",
"operationId": "GetDocumentTypeByIdCompositionReferences",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeCompositionResponseModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}/copy": {
"post": {
"tags": [
"Document Type"
],
"summary": "Copies a document type.",
"description": "Creates a duplicate of an existing document type identified by the provided Id.",
"operationId": "PostDocumentTypeByIdCopy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CopyDocumentTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}/export": {
"get": {
"tags": [
"Document Type"
],
"summary": "Exports a document type.",
"description": "Exports the document type identified by the provided Id to a downloadable format.",
"operationId": "GetDocumentTypeByIdExport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}/import": {
"put": {
"tags": [
"Document Type"
],
"summary": "Imports a document type.",
"description": "Imports a document type from the provided file upload.",
"operationId": "PutDocumentTypeByIdImport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportDocumentTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}/move": {
"put": {
"tags": [
"Document Type"
],
"summary": "Moves a document type.",
"description": "Moves a document type identified by the provided Id to a different location.",
"operationId": "PutDocumentTypeByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveDocumentTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}/schema": {
"get": {
"tags": [
"Document Type"
],
"operationId": "GetDocumentTypeByIdSchema",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonObject"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}/template": {
"post": {
"tags": [
"Document Type"
],
"summary": "Creates a template for a document type.",
"description": "Creates a new template associated with the document type identified by the provided Id.",
"operationId": "PostDocumentTypeByIdTemplate",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDocumentTypeTemplateRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/allowed-at-root": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets document types allowed at root.",
"description": "Gets a collection of document types that are allowed to be created at the root level.",
"operationId": "GetDocumentTypeAllowedAtRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAllowedDocumentTypeModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/allowed-in-library": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets document types allowed in library.",
"description": "Gets a collection of document types that are allowed in the library.",
"operationId": "GetDocumentTypeAllowedInLibrary",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAllowedDocumentTypeModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/available-compositions": {
"post": {
"tags": [
"Document Type"
],
"summary": "Gets available compositions.",
"description": "Gets a collection of document types that are available to use as compositions for the specified document type.",
"operationId": "PostDocumentTypeAvailableCompositions",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentTypeCompositionRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableDocumentTypeCompositionResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/batch": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets multiple document types.",
"description": "Gets multiple document types identified by the provided Ids.",
"operationId": "GetDocumentTypeBatch",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseModelDocumentTypeResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/configuration": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets the document type configuration.",
"description": "Gets the configuration settings for document types.",
"operationId": "GetDocumentTypeConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentTypeConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/folder": {
"post": {
"tags": [
"Document Type"
],
"summary": "Creates a document type folder.",
"description": "Creates a new document type folder with the provided name and parent location.",
"operationId": "PostDocumentTypeFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFolderRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/folder/{id}": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets a document type folder.",
"description": "Gets a document type folder identified by the provided Id.",
"operationId": "GetDocumentTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Document Type"
],
"summary": "Deletes a document type folder.",
"description": "Deletes a document type folder identified by the provided Id.",
"operationId": "DeleteDocumentTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Document Type"
],
"summary": "Updates a document type folder.",
"description": "Updates a document type folder identified by the provided Id with the details from the request model.",
"operationId": "PutDocumentTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFolderResponseModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-type/import": {
"post": {
"tags": [
"Document Type"
],
"summary": "Imports a document type.",
"description": "Imports a document type from the provided file upload.",
"operationId": "PostDocumentTypeImport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportDocumentTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/document-type": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets a collection of document type items.",
"description": "Gets a collection of document type items identified by the provided Ids.",
"operationId": "GetItemDocumentType",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/document-type/ancestors": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets ancestors for a collection of document type items.",
"description": "Gets the ancestor chains for document type items identified by the provided Ids.",
"operationId": "GetItemDocumentTypeAncestors",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemAncestorsResponseModelNamedItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/document-type/search": {
"get": {
"tags": [
"Document Type"
],
"summary": "Searches document type items.",
"description": "Searches document type items by the provided query with pagination support.",
"operationId": "GetItemDocumentTypeSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "isElement",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedModelDocumentTypeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document-type/ancestors": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets a collection of ancestor document type items.",
"description": "Gets a collection of document type items that are ancestors to the provided Id.",
"operationId": "GetTreeDocumentTypeAncestors",
"parameters": [
{
"name": "descendantId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeTreeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document-type/children": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets a collection of document type tree child items.",
"description": "Gets a paginated collection of document type tree items that are children of the provided parent Id.",
"operationId": "GetTreeDocumentTypeChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document-type/root": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets a collection of document type items from the root of the tree.",
"description": "Gets a paginated collection of document type items from the root of the tree with optional filtering.",
"operationId": "GetTreeDocumentTypeRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document-type/search": {
"get": {
"tags": [
"Document Type"
],
"operationId": "GetTreeDocumentTypeSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "itemKind",
"in": "query",
"schema": {
"default": "All",
"$ref": "#/components/schemas/TreeItemKindModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/document-type/siblings": {
"get": {
"tags": [
"Document Type"
],
"summary": "Gets a collection of document type tree sibling items.",
"description": "Gets a collection of document type tree items that are siblings of the provided Id.",
"operationId": "GetTreeDocumentTypeSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetDocumentTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-version": {
"get": {
"tags": [
"Document Version"
],
"summary": "Gets a paginated collection of versions for a specific document.",
"description": "Gets a paginated collection of versions for a specific document and optional culture. Each result describes the version and includes details of the document type, editor, version date, and published status.",
"operationId": "GetDocumentVersion",
"parameters": [
{
"name": "documentId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentVersionItemResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-version/{id}": {
"get": {
"tags": [
"Document Version"
],
"summary": "Gets a specific document version.",
"description": "Gets a specific document version by its Id. If found, the result describes the version and includes details of the document type, editor, version date, and published status.",
"operationId": "GetDocumentVersionById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentVersionResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-version/{id}/prevent-cleanup": {
"put": {
"tags": [
"Document Version"
],
"summary": "Sets the prevent clean up status for a document version.",
"description": "Sets the prevent clean up boolean status for a document version to the provided value. This controls whether the version will be a candidate for removal in content history clean up.",
"operationId": "PutDocumentVersionByIdPreventCleanup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "preventCleanup",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/document-version/{id}/rollback": {
"post": {
"tags": [
"Document Version"
],
"summary": "Rolls back a document to a specific version.",
"description": "Rolls back a document to the version indicated by the provided Id. This will archive the current version of the document and publish the provided one.",
"operationId": "PostDocumentVersionByIdRollback",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/dynamic-root/query": {
"post": {
"tags": [
"Dynamic Root"
],
"summary": "Gets dynamic roots.",
"description": "Gets a collection of dynamic root items based on the provided query configuration.",
"operationId": "PostDynamicRootQuery",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DynamicRootRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DynamicRootResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/dynamic-root/steps": {
"get": {
"tags": [
"Dynamic Root"
],
"summary": "Gets dynamic root query steps.",
"description": "Gets a collection of available query steps for configuring dynamic root queries.",
"operationId": "GetDynamicRootSteps",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element": {
"post": {
"tags": [
"Element"
],
"summary": "Creates a new element.",
"description": "Creates a new element with the configuration specified in the request model.",
"operationId": "PostElement",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateElementRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/{id}": {
"get": {
"tags": [
"Element"
],
"summary": "Gets an element.",
"description": "Gets an element identified by the provided Id.",
"operationId": "GetElementById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ElementResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Element"
],
"summary": "Deletes an element.",
"description": "Deletes an element identified by the provided Id.",
"operationId": "DeleteElementById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Element"
],
"summary": "Updates an element.",
"description": "Updates an element identified by the provided Id with the details from the request model.",
"operationId": "PutElementById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateElementRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/{id}/audit-log": {
"get": {
"tags": [
"Element"
],
"summary": "Gets the audit log for an element.",
"description": "Gets a paginated collection of audit log entries for the element identified by the provided Id.",
"operationId": "GetElementByIdAuditLog",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "orderDirection",
"in": "query",
"schema": {
"default": "Descending",
"$ref": "#/components/schemas/DirectionModel"
}
},
{
"name": "sinceDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAuditLogResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/{id}/copy": {
"post": {
"tags": [
"Element"
],
"summary": "Copies an element.",
"description": "Creates a duplicate of an existing element identified by the provided Id.",
"operationId": "PostElementByIdCopy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CopyElementRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/{id}/move": {
"put": {
"tags": [
"Element"
],
"summary": "Moves an element.",
"description": "Moves an element identified by the provided Id to a different location.",
"operationId": "PutElementByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveElementRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/{id}/move-to-recycle-bin": {
"put": {
"tags": [
"Element"
],
"summary": "Moves an element to the recycle bin.",
"description": "Moves an element identified by the provided Id to the recycle bin.",
"operationId": "PutElementByIdMoveToRecycleBin",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/{id}/publish": {
"put": {
"tags": [
"Element"
],
"summary": "Publishes an element.",
"description": "Publishes an element identified by the provided Id.",
"operationId": "PutElementByIdPublish",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishElementRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/{id}/published": {
"get": {
"tags": [
"Element"
],
"summary": "Gets a published element.",
"description": "Gets a published element identified by the provided Id.",
"operationId": "GetElementByIdPublished",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishedElementResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/{id}/referenced-by": {
"get": {
"tags": [
"Element"
],
"summary": "Gets items referencing an element.",
"description": "Gets a paginated collection of items that reference the element identified by the provided Id.",
"operationId": "GetElementByIdReferencedBy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/{id}/unpublish": {
"put": {
"tags": [
"Element"
],
"summary": "Unpublishes an element.",
"description": "Unpublishes an element identified by the provided Id.",
"operationId": "PutElementByIdUnpublish",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnpublishElementRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/{id}/update-and-publish": {
"put": {
"tags": [
"Element"
],
"summary": "Updates and publishes an element.",
"description": "Updates and publishes an element identified by the provided Id with the details from the request model.",
"operationId": "PutElementByIdUpdateAndPublish",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAndPublishElementRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/{id}/validate": {
"put": {
"tags": [
"Element"
],
"summary": "Validates updating an element.",
"description": "Validates the request model for updating an element without actually updating it.",
"operationId": "PutElementByIdValidate",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateUpdateElementRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/are-referenced": {
"get": {
"tags": [
"Element"
],
"summary": "Gets a collection of items that reference elements.",
"description": "Gets a paginated collection of items that reference the elements identified by the provided Ids.",
"operationId": "GetElementAreReferenced",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedReferenceByIdModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/configuration": {
"get": {
"tags": [
"Element"
],
"summary": "Gets the element configuration.",
"description": "Gets the configuration settings for elements.",
"operationId": "GetElementConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ElementConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/create-and-publish": {
"post": {
"tags": [
"Element"
],
"summary": "Creates and publishes a new element.",
"description": "Creates and publishes a new element with the configuration specified in the request model.",
"operationId": "PostElementCreateAndPublish",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAndPublishElementRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/folder": {
"post": {
"tags": [
"Element"
],
"summary": "Creates an element folder.",
"description": "Creates a new element folder with the provided name and parent location.",
"operationId": "PostElementFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFolderRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/folder/{id}": {
"get": {
"tags": [
"Element"
],
"summary": "Gets an element folder.",
"description": "Gets an element folder identified by the provided Id.",
"operationId": "GetElementFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Element"
],
"summary": "Deletes an element folder.",
"description": "Deletes an element folder identified by the provided Id.",
"operationId": "DeleteElementFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Element"
],
"summary": "Updates an element folder.",
"description": "Updates an element folder identified by the provided Id with the details provided in the request model.",
"operationId": "PutElementFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFolderResponseModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/folder/{id}/move": {
"put": {
"tags": [
"Element"
],
"summary": "Moves an element folder.",
"description": "Moves an element folder identified by the provided Id to a different location.",
"operationId": "PutElementFolderByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveFolderRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/folder/{id}/move-to-recycle-bin": {
"put": {
"tags": [
"Element"
],
"summary": "Moves an element folder to the recycle bin.",
"description": "Moves an element folder identified by the provided Id to the recycle bin.",
"operationId": "PutElementFolderByIdMoveToRecycleBin",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/folder/{id}/referenced-descendants": {
"get": {
"tags": [
"Element"
],
"summary": "Gets element folder descendants that are referenced.",
"description": "Gets a paginated collection of descendant elements in a folder that are referenced by other content.",
"operationId": "GetElementFolderByIdReferencedDescendants",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedReferenceByIdModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element/validate": {
"post": {
"tags": [
"Element"
],
"summary": "Validates creating an element.",
"description": "Validates the request model for creating a new element without actually creating it.",
"operationId": "PostElementValidate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateElementRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/element": {
"get": {
"tags": [
"Element"
],
"summary": "Gets a collection of element items.",
"description": "Gets a collection of element items identified by the provided Ids.",
"operationId": "GetItemElement",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/element/ancestors": {
"get": {
"tags": [
"Element"
],
"summary": "Gets ancestors for a collection of element items.",
"description": "Gets the ancestor chains for element items identified by the provided Ids.",
"operationId": "GetItemElementAncestors",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemAncestorsResponseModelNamedItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/element/folder": {
"get": {
"tags": [
"Element"
],
"summary": "Gets a collection of element folder items.",
"description": "Gets a collection of element folder items identified by the provided Ids.",
"operationId": "GetItemElementFolder",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/element/search": {
"get": {
"tags": [
"Element"
],
"summary": "Searches element items.",
"description": "Searches element items by the provided query with pagination support.",
"operationId": "GetItemElementSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedModelElementItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/element": {
"delete": {
"tags": [
"Element"
],
"summary": "Empties the element recycle bin.",
"description": "Permanently deletes all elements in the recycle bin. This operation cannot be undone.",
"operationId": "DeleteRecycleBinElement",
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/element/{id}": {
"delete": {
"tags": [
"Element"
],
"summary": "Deletes an element from the recycle bin.",
"description": "Permanently deletes an element identified by the provided Id from the recycle bin.",
"operationId": "DeleteRecycleBinElementById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/element/{id}/original-parent": {
"get": {
"tags": [
"Element"
],
"summary": "Gets the original parent of an element in the recycle bin.",
"description": "Gets the original parent location of an element before it was moved to the recycle bin.",
"operationId": "GetRecycleBinElementByIdOriginalParent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/element/{id}/restore": {
"put": {
"tags": [
"Element"
],
"summary": "Restores an element from the recycle bin.",
"description": "Restores an element from the recycle bin to its original location or a specified parent.",
"operationId": "PutRecycleBinElementByIdRestore",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveElementRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/element/children": {
"get": {
"tags": [
"Element"
],
"summary": "Gets a collection of elements in the recycle bin.",
"description": "Gets a paginated collection of elements that are children of the provided parent in the recycle bin.",
"operationId": "GetRecycleBinElementChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedElementRecycleBinItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/element/folder/{id}": {
"delete": {
"tags": [
"Element"
],
"summary": "Deletes an element folder from the recycle bin.",
"description": "Permanently deletes an element folder identified by the provided Id from the recycle bin.",
"operationId": "DeleteRecycleBinElementFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/element/folder/{id}/original-parent": {
"get": {
"tags": [
"Element"
],
"summary": "Gets the original parent of an element folder in the recycle bin.",
"description": "Gets the original parent location of an element folder before it was moved to the recycle bin.",
"operationId": "GetRecycleBinElementFolderByIdOriginalParent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/element/folder/{id}/restore": {
"put": {
"tags": [
"Element"
],
"summary": "Restores an element folder from the recycle bin.",
"description": "Restores an element folder from the recycle bin to its original location or a specified parent.",
"operationId": "PutRecycleBinElementFolderByIdRestore",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveFolderRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/element/referenced-by": {
"get": {
"tags": [
"Element"
],
"summary": "Gets items referencing an element in the recycle bin.",
"description": "Gets a paginated collection of items that reference the element in the recycle bin.",
"operationId": "GetRecycleBinElementReferencedBy",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/element/root": {
"get": {
"tags": [
"Element"
],
"summary": "Gets elements at the root of the recycle bin.",
"description": "Gets a paginated collection of elements at the root level of the recycle bin.",
"operationId": "GetRecycleBinElementRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedElementRecycleBinItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/element/siblings": {
"get": {
"tags": [
"Element"
],
"summary": "Gets sibling elements in the recycle bin.",
"description": "Gets a collection of sibling elements in the recycle bin at the same level as the provided Id.",
"operationId": "GetRecycleBinElementSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetElementRecycleBinItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/element/ancestors": {
"get": {
"tags": [
"Element"
],
"summary": "Gets a collection of ancestor element items.",
"description": "Gets a collection of element items that are ancestors to the provided Id.",
"operationId": "GetTreeElementAncestors",
"parameters": [
{
"name": "descendantId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementTreeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/element/children": {
"get": {
"tags": [
"Element"
],
"summary": "Gets a collection of element tree child items.",
"description": "Gets a paginated collection of element tree items that are children of the provided parent Id.",
"operationId": "GetTreeElementChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedElementTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/element/root": {
"get": {
"tags": [
"Element"
],
"summary": "Gets a collection of element items from the root of the tree.",
"description": "Gets a paginated collection of element items from the root of the tree with optional filtering.",
"operationId": "GetTreeElementRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedElementTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/element/siblings": {
"get": {
"tags": [
"Element"
],
"summary": "Gets a collection of element tree sibling items.",
"description": "Gets a collection of element tree items that are siblings of the provided Id.",
"operationId": "GetTreeElementSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetElementTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element-version": {
"get": {
"tags": [
"Element Version"
],
"summary": "Gets a paginated collection of versions for a specific element.",
"description": "Gets a paginated collection of versions for a specific element and optional culture. Each result describes the version and includes details of the element type, editor, version date, and published status.",
"operationId": "GetElementVersion",
"parameters": [
{
"name": "elementId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedElementVersionItemResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element-version/{id}": {
"get": {
"tags": [
"Element Version"
],
"summary": "Gets a specific element version.",
"description": "Gets a specific element version by its Id. If found, the result describes the version and includes details of the element type, editor, version date, and published status.",
"operationId": "GetElementVersionById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ElementVersionResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element-version/{id}/prevent-cleanup": {
"put": {
"tags": [
"Element Version"
],
"summary": "Sets the prevent clean up status for an element version.",
"description": "Sets the prevent clean up boolean status for an element version to the provided value. This controls whether the version will be a candidate for removal in content history clean up.",
"operationId": "PutElementVersionByIdPreventCleanup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "preventCleanup",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/element-version/{id}/rollback": {
"post": {
"tags": [
"Element Version"
],
"summary": "Rolls back an element to a specific version.",
"description": "Rolls back an element to the version indicated by the provided Id. This will archive the current version of the element and publish the provided one.",
"operationId": "PostElementVersionByIdRollback",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/health-check-group": {
"get": {
"tags": [
"Health Check"
],
"summary": "Gets a collection of health check groups.",
"description": "Gets a collection of health check groups with their associated health checks.",
"operationId": "GetHealthCheckGroup",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedHealthCheckGroupResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/health-check-group/{name}": {
"get": {
"tags": [
"Health Check"
],
"summary": "Gets a health check group by name.",
"description": "Gets a health check group and all its associated health checks identified by the provided group name.",
"operationId": "GetHealthCheckGroupByName",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckGroupPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/health-check-group/{name}/check": {
"post": {
"tags": [
"Health Check"
],
"summary": "Executes all health checks in a group.",
"description": "Runs all health checks in the group identified by the provided name and returns the results.",
"operationId": "PostHealthCheckGroupByNameCheck",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckGroupWithResultResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/health-check/execute-action": {
"post": {
"tags": [
"Health Check"
],
"summary": "Executes a health check action.",
"description": "Executes a specific action to fix or address a health check issue.",
"operationId": "PostHealthCheckExecuteAction",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckActionRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckResultResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/help": {
"get": {
"tags": [
"Help"
],
"summary": "Gets help information.",
"description": "Gets help information and documentation resources for the Umbraco back office.",
"operationId": "GetHelp",
"parameters": [
{
"name": "section",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "tree",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "baseUrl",
"in": "query",
"schema": {
"type": "string",
"default": "https://our.umbraco.com"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedHelpPageResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/imaging/resize/urls": {
"get": {
"tags": [
"Imaging"
],
"summary": "Gets URLs for image resizing.",
"description": "Gets a collection of URLs for resizing images with the provided dimensions and options.",
"operationId": "GetImagingResizeUrls",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "height",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 200
}
},
{
"name": "width",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 200
}
},
{
"name": "mode",
"in": "query",
"schema": {
"$ref": "#/components/schemas/ImageCropModeModel"
}
},
{
"name": "format",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaUrlInfoResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/import/analyze": {
"get": {
"tags": [
"Import"
],
"summary": "Analyzes an import file.",
"description": "Analyzes the uploaded import file and returns an analysis of the imported entities.",
"operationId": "GetImportAnalyze",
"parameters": [
{
"name": "temporaryFileId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityImportAnalysisResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/indexer": {
"get": {
"tags": [
"Indexer"
],
"summary": "Gets a collection of indexers.",
"description": "Gets a collection of configured search indexers in the Umbraco installation.",
"operationId": "GetIndexer",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIndexResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/indexer/{indexName}": {
"get": {
"tags": [
"Indexer"
],
"summary": "Gets indexer details.",
"description": "Gets detailed information about the indexer identified by the provided name.",
"operationId": "GetIndexerByIndexName",
"parameters": [
{
"name": "indexName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/indexer/{indexName}/rebuild": {
"post": {
"tags": [
"Indexer"
],
"summary": "Rebuilds an indexer.",
"description": "Rebuilds the search index for the indexer identified by the provided name.",
"operationId": "PostIndexerByIndexNameRebuild",
"parameters": [
{
"name": "indexName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/install/settings": {
"get": {
"tags": [
"Install"
],
"summary": "Gets install settings.",
"description": "Gets the current installation settings and status.",
"operationId": "GetInstallSettings",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallSettingsResponseModel"
}
}
}
},
"428": {
"description": "Precondition Required",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": []
}
},
"/umbraco/management/api/v1/install/setup": {
"post": {
"tags": [
"Install"
],
"summary": "Performs installation setup.",
"description": "Performs the initial setup and installation of Umbraco.",
"operationId": "PostInstallSetup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"428": {
"description": "Precondition Required",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": []
}
},
"/umbraco/management/api/v1/install/validate-database": {
"post": {
"tags": [
"Install"
],
"summary": "Validates database connection.",
"description": "Validates the database connection settings provided during installation.",
"operationId": "PostInstallValidateDatabase",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabaseInstallRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": []
}
},
"/umbraco/management/api/v1/item/language": {
"get": {
"tags": [
"Language"
],
"summary": "Gets a collection of language items.",
"description": "Gets a collection of language items identified by the provided Ids.",
"operationId": "GetItemLanguage",
"parameters": [
{
"name": "isoCode",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/language/default": {
"get": {
"tags": [
"Language"
],
"summary": "Gets the default language.",
"description": "Gets the default language configured for the Umbraco installation.",
"operationId": "GetItemLanguageDefault",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/language": {
"get": {
"tags": [
"Language"
],
"summary": "Gets a paginated collection of languages.",
"description": "Gets a paginated collection of all configured languages.",
"operationId": "GetLanguage",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedLanguageResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"Language"
],
"summary": "Creates a new language.",
"description": "Creates a new language with the configuration specified in the request model.",
"operationId": "PostLanguage",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateLanguageRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/language/{isoCode}": {
"get": {
"tags": [
"Language"
],
"summary": "Gets a language by ISO code.",
"description": "Gets a language identified by the provided ISO code.",
"operationId": "GetLanguageByIsoCode",
"parameters": [
{
"name": "isoCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Language"
],
"summary": "Deletes a language.",
"description": "Deletes a language identified by the provided Id.",
"operationId": "DeleteLanguageByIsoCode",
"parameters": [
{
"name": "isoCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Language"
],
"summary": "Updates a language.",
"description": "Updates a language identified by the provided Id with the details from the request model.",
"operationId": "PutLanguageByIsoCode",
"parameters": [
{
"name": "isoCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLanguageRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/log-viewer/level": {
"get": {
"tags": [
"Log Viewer"
],
"summary": "Gets a collection of log sink levels.",
"description": "Gets a collection of configured log sinks with their minimum log levels.",
"operationId": "GetLogViewerLevel",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedLoggerResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/log-viewer/level-count": {
"get": {
"tags": [
"Log Viewer"
],
"summary": "Gets log level counts.",
"description": "Gets the count of log entries for each log level within the specified date range.",
"operationId": "GetLogViewerLevelCount",
"parameters": [
{
"name": "startDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogLevelCountsReponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/log-viewer/log": {
"get": {
"tags": [
"Log Viewer"
],
"summary": "Gets a paginated collection of log entries.",
"description": "Gets a paginated collection of log entries with optional filtering and date range.",
"operationId": "GetLogViewerLog",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "orderDirection",
"in": "query",
"schema": {
"default": "Descending",
"$ref": "#/components/schemas/DirectionModel"
}
},
{
"name": "filterExpression",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "logLevel",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogLevelModel"
}
}
},
{
"name": "startDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedLogMessageResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/log-viewer/message-template": {
"get": {
"tags": [
"Log Viewer"
],
"summary": "Gets a collection of log message templates.",
"description": "Gets a paginated collection of unique message templates found in the logs.",
"operationId": "GetLogViewerMessageTemplate",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "startDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedLogTemplateResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/log-viewer/saved-search": {
"get": {
"tags": [
"Log Viewer"
],
"summary": "Gets a collection of saved log searches.",
"description": "Gets a collection of saved log searches defined in the Umbraco installation.",
"operationId": "GetLogViewerSavedSearch",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedSavedLogSearchResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"Log Viewer"
],
"summary": "Creates a saved log search.",
"description": "Creates a new saved log search with the provided name and query configuration.",
"operationId": "PostLogViewerSavedSearch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedLogSearchRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/log-viewer/saved-search/{name}": {
"get": {
"tags": [
"Log Viewer"
],
"summary": "Gets a saved log search by name.",
"description": "Gets a saved log search identified by the provided name.",
"operationId": "GetLogViewerSavedSearchByName",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedLogSearchResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Log Viewer"
],
"summary": "Deletes a saved log search.",
"description": "Deletes a saved log search identified by the provided name.",
"operationId": "DeleteLogViewerSavedSearchByName",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/log-viewer/validate-logs-size": {
"get": {
"tags": [
"Log Viewer"
],
"summary": "Validates if logs can be viewed.",
"description": "Checks if the log files are within the size limit and can be viewed.",
"operationId": "GetLogViewerValidateLogsSize",
"parameters": [
{
"name": "startDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/manifest/manifest": {
"get": {
"tags": [
"Manifest"
],
"summary": "Gets all manifests.",
"description": "Gets a collection of all package manifests including both public and private manifests.",
"operationId": "GetManifestManifest",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManifestResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/manifest/manifest/private": {
"get": {
"tags": [
"Manifest"
],
"summary": "Gets private manifests.",
"description": "Gets a collection of private package manifests specific to the current user.",
"operationId": "GetManifestManifestPrivate",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManifestResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/manifest/manifest/public": {
"get": {
"tags": [
"Manifest"
],
"summary": "Gets public manifests.",
"description": "Gets a collection of public package manifests available to all users.",
"operationId": "GetManifestManifestPublic",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManifestResponseModel"
}
}
}
}
}
},
"security": []
}
},
"/umbraco/management/api/v1/collection/media": {
"get": {
"tags": [
"Media"
],
"summary": "Gets a collection of media items.",
"description": "Gets a paginated collection of media items, optionally filtered and sorted.",
"operationId": "GetCollectionMedia",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "orderBy",
"in": "query",
"schema": {
"type": "string",
"default": "updateDate"
}
},
{
"name": "orderDirection",
"in": "query",
"schema": {
"default": "Ascending",
"$ref": "#/components/schemas/DirectionModel"
}
},
{
"name": "filter",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedMediaCollectionResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/media": {
"get": {
"tags": [
"Media"
],
"summary": "Gets a collection of media items.",
"description": "Gets a collection of media items identified by the provided Ids.",
"operationId": "GetItemMedia",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/media/ancestors": {
"get": {
"tags": [
"Media"
],
"summary": "Gets ancestors for a collection of media items.",
"description": "Gets the ancestor chains for media items identified by the provided Ids.",
"operationId": "GetItemMediaAncestors",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemAncestorsResponseModelMediaItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/media/search": {
"get": {
"tags": [
"Media"
],
"summary": "Searches media items.",
"description": "Searches media items by the provided query with pagination support.",
"operationId": "GetItemMediaSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "trashed",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "allowedMediaTypes",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedModelMediaItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media": {
"post": {
"tags": [
"Media"
],
"summary": "Creates a new media.",
"description": "Creates a new media with the configuration specified in the request model.",
"operationId": "PostMedia",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMediaRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/{id}": {
"get": {
"tags": [
"Media"
],
"summary": "Gets a media item.",
"description": "Gets a media item identified by the provided Id.",
"operationId": "GetMediaById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Media"
],
"summary": "Deletes a media item.",
"description": "Deletes a media item identified by the provided Id.",
"operationId": "DeleteMediaById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Media"
],
"summary": "Updates a media item.",
"description": "Updates a media item identified by the provided Id with the details from the request model.",
"operationId": "PutMediaById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMediaRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/{id}/audit-log": {
"get": {
"tags": [
"Media"
],
"summary": "Gets the audit log for a media item.",
"description": "Gets a paginated collection of audit log entries for the media identified by the provided Id.",
"operationId": "GetMediaByIdAuditLog",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "orderDirection",
"in": "query",
"schema": {
"default": "Descending",
"$ref": "#/components/schemas/DirectionModel"
}
},
{
"name": "sinceDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAuditLogResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/{id}/move": {
"put": {
"tags": [
"Media"
],
"summary": "Moves a media item.",
"description": "Moves a media item identified by the provided Id to a different location.",
"operationId": "PutMediaByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveMediaRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/{id}/move-to-recycle-bin": {
"put": {
"tags": [
"Media"
],
"summary": "Moves a media item to the recycle bin.",
"description": "Moves a media item identified by the provided Id to the recycle bin.",
"operationId": "PutMediaByIdMoveToRecycleBin",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/{id}/referenced-by": {
"get": {
"tags": [
"Media"
],
"summary": "Gets a collection of items that reference a media item.",
"description": "Gets a paginated collection of items that reference the media item identified by the provided Id.",
"operationId": "GetMediaByIdReferencedBy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/{id}/referenced-descendants": {
"get": {
"tags": [
"Media"
],
"summary": "Gets media descendants that are referenced.",
"description": "Gets a paginated collection of descendant media items that are referenced by other content.",
"operationId": "GetMediaByIdReferencedDescendants",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedReferenceByIdModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/{id}/sort-children": {
"put": {
"tags": [
"Media"
],
"summary": "Sorts the children of a media item by a field.",
"description": "Sorts the children of the specified parent media item by a system field in the given direction.",
"operationId": "PutMediaByIdSortChildren",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortMediaChildrenByFieldRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/{id}/validate": {
"put": {
"tags": [
"Media"
],
"summary": "Validates updating a media item.",
"description": "Validates the request model for updating a media item without actually updating it.",
"operationId": "PutMediaByIdValidate",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMediaRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/are-referenced": {
"get": {
"tags": [
"Media"
],
"summary": "Gets a collection of referenced media items.",
"description": "Gets a paginated collection of media items that are referenced, identified by the provided Ids.",
"operationId": "GetMediaAreReferenced",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedReferenceByIdModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/configuration": {
"get": {
"tags": [
"Media"
],
"summary": "Gets the media configuration.",
"description": "Gets the configuration settings for media.",
"operationId": "GetMediaConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/root/sort-children": {
"put": {
"tags": [
"Media"
],
"summary": "Sorts the root-level media items by a field.",
"description": "Sorts the root-level media items by a system field in the given direction.",
"operationId": "PutMediaRootSortChildren",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortMediaChildrenByFieldRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/sort": {
"put": {
"tags": [
"Media"
],
"summary": "Sorts media items.",
"description": "Sorts media items in the specified parent container according to the provided sort order.",
"operationId": "PutMediaSort",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortingRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/urls": {
"get": {
"tags": [
"Media"
],
"summary": "Gets URLs for media items.",
"description": "Gets the URLs for the media items identified by the provided Ids.",
"operationId": "GetMediaUrls",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaUrlInfoResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media/validate": {
"post": {
"tags": [
"Media"
],
"summary": "Validates creating a media item.",
"description": "Validates the request model for creating a new media item without actually creating it.",
"operationId": "PostMediaValidate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMediaRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/media": {
"delete": {
"tags": [
"Media"
],
"summary": "Empties the media recycle bin.",
"description": "Permanently deletes all media items in the recycle bin. This operation cannot be undone.",
"operationId": "DeleteRecycleBinMedia",
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/media/{id}": {
"delete": {
"tags": [
"Media"
],
"summary": "Deletes a media item from the recycle bin.",
"description": "Permanently deletes a media item from the recycle bin identified by the provided Id.",
"operationId": "DeleteRecycleBinMediaById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/media/{id}/original-parent": {
"get": {
"tags": [
"Media"
],
"summary": "Gets the original parent of a media item in the recycle bin.",
"description": "Gets the original parent location of a media item before it was moved to the recycle bin.",
"operationId": "GetRecycleBinMediaByIdOriginalParent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/media/{id}/restore": {
"put": {
"tags": [
"Media"
],
"summary": "Restores a media item from the recycle bin.",
"description": "Restores a media item from the recycle bin to its original location or a specified parent.",
"operationId": "PutRecycleBinMediaByIdRestore",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveMediaRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/media/children": {
"get": {
"tags": [
"Media"
],
"summary": "Gets a collection of media items in the recycle bin.",
"description": "Gets a paginated collection of media items that are children of the provided parent in the recycle bin.",
"operationId": "GetRecycleBinMediaChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedMediaRecycleBinItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/media/referenced-by": {
"get": {
"tags": [
"Media"
],
"summary": "Gets items referencing media in the recycle bin.",
"description": "Gets a paginated collection of items that reference the media in the recycle bin.",
"operationId": "GetRecycleBinMediaReferencedBy",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/media/root": {
"get": {
"tags": [
"Media"
],
"summary": "Gets media at the root of the recycle bin.",
"description": "Gets a paginated collection of media items at the root level of the recycle bin.",
"operationId": "GetRecycleBinMediaRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedMediaRecycleBinItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/media/siblings": {
"get": {
"tags": [
"Media"
],
"summary": "Gets sibling media in the recycle bin.",
"description": "Gets a collection of sibling media items in the recycle bin at the same level as the provided Id.",
"operationId": "GetRecycleBinMediaSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetMediaRecycleBinItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/media/ancestors": {
"get": {
"tags": [
"Media"
],
"summary": "Gets a collection of ancestor media items.",
"description": "Gets a collection of media items that are ancestors to the provided Id.",
"operationId": "GetTreeMediaAncestors",
"parameters": [
{
"name": "descendantId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTreeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/media/children": {
"get": {
"tags": [
"Media"
],
"summary": "Gets a collection of media tree child items.",
"description": "Gets a paginated collection of media tree items that are children of the provided parent Id.",
"operationId": "GetTreeMediaChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedMediaTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/media/root": {
"get": {
"tags": [
"Media"
],
"summary": "Gets a collection of media items from the root of the tree.",
"description": "Gets a paginated collection of media items from the root of the tree with optional filtering.",
"operationId": "GetTreeMediaRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedMediaTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/media/siblings": {
"get": {
"tags": [
"Media"
],
"summary": "Gets a collection of media tree sibling items.",
"description": "Gets a collection of media tree items that are siblings of the provided Id.",
"operationId": "GetTreeMediaSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetMediaTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/media-type": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets a collection of media type items.",
"description": "Gets a collection of media type items identified by the provided Ids.",
"operationId": "GetItemMediaType",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/media-type/allowed": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets a collection of media type items.",
"description": "Gets a collection of allowed media type items for the specified file extension.",
"operationId": "GetItemMediaTypeAllowed",
"parameters": [
{
"name": "fileExtension",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedModelAllowedMediaTypeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/media-type/ancestors": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets ancestors for a collection of media type items.",
"description": "Gets the ancestor chains for media type items identified by the provided Ids.",
"operationId": "GetItemMediaTypeAncestors",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemAncestorsResponseModelNamedItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/media-type/folders": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets a collection of media type folder items.",
"description": "Gets a paginated collection of media type folder items.",
"operationId": "GetItemMediaTypeFolders",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedModelMediaTypeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/media-type/search": {
"get": {
"tags": [
"Media Type"
],
"summary": "Searches media type items.",
"description": "Searches media type items by the provided query with pagination support.",
"operationId": "GetItemMediaTypeSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedModelMediaTypeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type": {
"post": {
"tags": [
"Media Type"
],
"summary": "Creates a new media type.",
"description": "Creates a new media type with the configuration specified in the request model.",
"operationId": "PostMediaType",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMediaTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/{id}": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets a media type.",
"description": "Gets a media type identified by the provided Id.",
"operationId": "GetMediaTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaTypeResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Media Type"
],
"summary": "Deletes a media type.",
"description": "Deletes a media type identified by the provided Id.",
"operationId": "DeleteMediaTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Media Type"
],
"summary": "Updates a media type.",
"description": "Updates a media type identified by the provided Id with the details from the request model.",
"operationId": "PutMediaTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMediaTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/{id}/allowed-children": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets allowed child media types.",
"description": "Gets a collection of media types that are allowed as children of the specified parent media type.",
"operationId": "GetMediaTypeByIdAllowedChildren",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "parentContentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAllowedMediaTypeModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/{id}/allowed-parents": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets allowed parent media types.",
"description": "Gets a collection of media types that are allowed as parents of the specified media type.",
"operationId": "GetMediaTypeByIdAllowedParents",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaTypeAllowedParentsResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/{id}/composition-references": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets composition references.",
"description": "Gets a collection of media types that reference the specified media type as a composition.",
"operationId": "GetMediaTypeByIdCompositionReferences",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeCompositionResponseModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/{id}/copy": {
"post": {
"tags": [
"Media Type"
],
"summary": "Copies a media type.",
"description": "Creates a duplicate of an existing media type identified by the provided Id.",
"operationId": "PostMediaTypeByIdCopy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CopyMediaTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/{id}/export": {
"get": {
"tags": [
"Media Type"
],
"summary": "Exports a media type.",
"description": "Exports the media type identified by the provided Id to a downloadable format.",
"operationId": "GetMediaTypeByIdExport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/{id}/import": {
"put": {
"tags": [
"Media Type"
],
"summary": "Imports a media type.",
"description": "Imports a media type from the provided file upload.",
"operationId": "PutMediaTypeByIdImport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportMediaTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/{id}/move": {
"put": {
"tags": [
"Media Type"
],
"summary": "Moves a media type.",
"description": "Moves a media type identified by the provided Id to a different location.",
"operationId": "PutMediaTypeByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveMediaTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/{id}/schema": {
"get": {
"tags": [
"Media Type"
],
"operationId": "GetMediaTypeByIdSchema",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonObject"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/allowed-at-root": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets media types allowed at root.",
"description": "Gets a collection of media types that are allowed to be created at the root level.",
"operationId": "GetMediaTypeAllowedAtRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAllowedMediaTypeModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/available-compositions": {
"post": {
"tags": [
"Media Type"
],
"summary": "Gets available compositions.",
"description": "Gets a collection of media types that are available to use as compositions for the specified media type.",
"operationId": "PostMediaTypeAvailableCompositions",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaTypeCompositionRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableMediaTypeCompositionResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/batch": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets multiple media types.",
"description": "Gets multiple media types identified by the provided Ids.",
"operationId": "GetMediaTypeBatch",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseModelMediaTypeResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/configuration": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets the media type configuration.",
"description": "Gets the configuration settings for media types.",
"operationId": "GetMediaTypeConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaTypeConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/folder": {
"post": {
"tags": [
"Media Type"
],
"summary": "Creates a media type folder.",
"description": "Creates a new media type folder with the provided name and parent location.",
"operationId": "PostMediaTypeFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFolderRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/folder/{id}": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets a media type folder.",
"description": "Gets a media type folder identified by the provided Id.",
"operationId": "GetMediaTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Media Type"
],
"summary": "Deletes a media type folder.",
"description": "Deletes a media type folder identified by the provided Id.",
"operationId": "DeleteMediaTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Media Type"
],
"summary": "Updates a media type folder.",
"description": "Updates a media type folder identified by the provided Id with the details from the request model.",
"operationId": "PutMediaTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFolderResponseModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/media-type/import": {
"post": {
"tags": [
"Media Type"
],
"summary": "Imports a media type.",
"description": "Imports a media type from the provided file upload.",
"operationId": "PostMediaTypeImport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportMediaTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/media-type/ancestors": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets a collection of ancestor media type items.",
"description": "Gets a collection of media type items that are ancestors to the provided Id.",
"operationId": "GetTreeMediaTypeAncestors",
"parameters": [
{
"name": "descendantId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeTreeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/media-type/children": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets a collection of media type tree child items.",
"description": "Gets a paginated collection of media type tree items that are children of the provided parent Id.",
"operationId": "GetTreeMediaTypeChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedMediaTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/media-type/root": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets a collection of media type items from the root of the tree.",
"description": "Gets a paginated collection of media type items from the root of the tree with optional filtering.",
"operationId": "GetTreeMediaTypeRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedMediaTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/media-type/siblings": {
"get": {
"tags": [
"Media Type"
],
"summary": "Gets a collection of media type tree sibling items.",
"description": "Gets a collection of media type tree items that are siblings of the provided Id.",
"operationId": "GetTreeMediaTypeSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetMediaTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/filter/member": {
"get": {
"tags": [
"Member"
],
"summary": "Gets a filtered collection of members.",
"description": "Filters members based on the provided criteria with support for pagination.",
"operationId": "GetFilterMember",
"parameters": [
{
"name": "memberTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "memberGroupName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "isApproved",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "isLockedOut",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "orderBy",
"in": "query",
"schema": {
"type": "string",
"default": "username"
}
},
{
"name": "orderDirection",
"in": "query",
"schema": {
"default": "Ascending",
"$ref": "#/components/schemas/DirectionModel"
}
},
{
"name": "filter",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedMemberResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/member": {
"get": {
"tags": [
"Member"
],
"summary": "Gets a collection of member items.",
"description": "Gets a collection of member items identified by the provided Ids.",
"operationId": "GetItemMember",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/member/ancestors": {
"get": {
"tags": [
"Member"
],
"summary": "Gets ancestors for a collection of member items.",
"description": "Gets the ancestor chains for member items identified by the provided Ids.",
"operationId": "GetItemMemberAncestors",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemAncestorsResponseModelMemberItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/member/search": {
"get": {
"tags": [
"Member"
],
"summary": "Searches member items.",
"description": "Searches member items by the provided query with pagination support.",
"operationId": "GetItemMemberSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "allowedMemberTypes",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedModelMemberItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member": {
"post": {
"tags": [
"Member"
],
"summary": "Creates a new member.",
"description": "Creates a new member with the configuration specified in the request model.",
"operationId": "PostMember",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMemberRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member/{id}": {
"get": {
"tags": [
"Member"
],
"summary": "Gets a member.",
"description": "Gets a member identified by the provided Id.",
"operationId": "GetMemberById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Member"
],
"summary": "Deletes a member.",
"description": "Deletes a member identified by the provided Id.",
"operationId": "DeleteMemberById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Member"
],
"summary": "Updates a member.",
"description": "Updates a member identified by the provided Id with the details from the request model.",
"operationId": "PutMemberById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMemberRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member/{id}/referenced-by": {
"get": {
"tags": [
"Member"
],
"summary": "Gets a collection of items that reference members.",
"description": "Gets a paginated collection of items that reference the members identified by the provided Ids.",
"operationId": "GetMemberByIdReferencedBy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member/{id}/referenced-descendants": {
"get": {
"tags": [
"Member"
],
"summary": "Gets a paginated collection of referenced descendant members.",
"description": "Gets a paginated collection of descendant members that are referenced in relations for the member identified by the provided Id.",
"operationId": "GetMemberByIdReferencedDescendants",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedReferenceByIdModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member/{id}/validate": {
"put": {
"tags": [
"Member"
],
"summary": "Validates updating a member.",
"description": "Validates the request model for updating a member without actually updating it.",
"operationId": "PutMemberByIdValidate",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMemberRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member/are-referenced": {
"get": {
"tags": [
"Member"
],
"summary": "Gets a collection of items that reference members.",
"description": "Gets a paginated collection of items that reference the members identified by the provided Ids.",
"operationId": "GetMemberAreReferenced",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedReferenceByIdModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member/validate": {
"post": {
"tags": [
"Member"
],
"summary": "Validates creating a member.",
"description": "Validates the request model for creating a new member without actually creating it.",
"operationId": "PostMemberValidate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMemberRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/member-group": {
"get": {
"tags": [
"Member Group"
],
"summary": "Gets a collection of member group items.",
"description": "Gets a collection of member group items identified by the provided Ids.",
"operationId": "GetItemMemberGroup",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberGroupItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-group": {
"get": {
"tags": [
"Member Group"
],
"summary": "Gets a paginated collection of member groups.",
"description": "Gets a paginated collection of all member groups.",
"operationId": "GetMemberGroup",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedMemberGroupResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"Member Group"
],
"summary": "Creates a new member group.",
"description": "Creates a new member group with the configuration specified in the request model.",
"operationId": "PostMemberGroup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMemberGroupRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-group/{id}": {
"get": {
"tags": [
"Member Group"
],
"summary": "Gets a member group.",
"description": "Gets a member group identified by the provided Id.",
"operationId": "GetMemberGroupById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberGroupResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Member Group"
],
"summary": "Deletes a member group.",
"description": "Deletes a member group identified by the provided Id.",
"operationId": "DeleteMemberGroupById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Member Group"
],
"summary": "Updates a member group.",
"description": "Updates a member group identified by the provided Id with the details from the request model.",
"operationId": "PutMemberGroupById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMemberGroupRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/member-group/root": {
"get": {
"tags": [
"Member Group"
],
"summary": "Gets a collection of member group items from the root of the tree.",
"description": "Gets a paginated collection of member group items from the root of the tree with optional filtering.",
"operationId": "GetTreeMemberGroupRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedNamedEntityTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/member-type": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets a collection of member type items.",
"description": "Gets a collection of member type items identified by the provided Ids.",
"operationId": "GetItemMemberType",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/member-type/ancestors": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets ancestors for a collection of member type items.",
"description": "Gets the ancestor chains for member type items identified by the provided Ids.",
"operationId": "GetItemMemberTypeAncestors",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemAncestorsResponseModelNamedItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/member-type/search": {
"get": {
"tags": [
"Member Type"
],
"summary": "Searches member type items.",
"description": "Searches member type items by the provided query with pagination support.",
"operationId": "GetItemMemberTypeSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedModelMemberTypeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type": {
"post": {
"tags": [
"Member Type"
],
"summary": "Creates a new member type.",
"description": "Creates a new member type with the configuration specified in the request model.",
"operationId": "PostMemberType",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMemberTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/{id}": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets a member type.",
"description": "Gets a member type identified by the provided Id.",
"operationId": "GetMemberTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberTypeResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Member Type"
],
"summary": "Deletes a member type.",
"description": "Deletes a member type identified by the provided Id.",
"operationId": "DeleteMemberTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Member Type"
],
"summary": "Updates a member type.",
"description": "Updates a member type identified by the provided Id with the details from the request model.",
"operationId": "PutMemberTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMemberTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/{id}/composition-references": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets composition references.",
"description": "Gets a collection of member types that reference the specified member type as a composition.",
"operationId": "GetMemberTypeByIdCompositionReferences",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypeCompositionResponseModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/{id}/copy": {
"post": {
"tags": [
"Member Type"
],
"summary": "Copies a member type.",
"description": "Creates a duplicate of an existing member type identified by the provided Id.",
"operationId": "PostMemberTypeByIdCopy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/CopyMemberTypeRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/{id}/export": {
"get": {
"tags": [
"Member Type"
],
"summary": "Exports a member type.",
"description": "Exports the member type identified by the provided Id to a downloadable format.",
"operationId": "GetMemberTypeByIdExport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/{id}/import": {
"put": {
"tags": [
"Member Type"
],
"summary": "Imports a member type.",
"description": "Imports a member type from the provided file upload.",
"operationId": "PutMemberTypeByIdImport",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportMemberTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/{id}/move": {
"put": {
"tags": [
"Member Type"
],
"summary": "Moves a member type.",
"description": "Moves a member type identified by the provided Id to a different location.",
"operationId": "PutMemberTypeByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveMemberTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/{id}/schema": {
"get": {
"tags": [
"Member Type"
],
"operationId": "GetMemberTypeByIdSchema",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonObject"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/allowed-at-root": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets member types allowed at root.",
"description": "Gets a collection of member types that are allowed to be created at the root level.",
"operationId": "GetMemberTypeAllowedAtRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAllowedMemberTypeModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/available-compositions": {
"post": {
"tags": [
"Member Type"
],
"summary": "Gets available compositions.",
"description": "Gets a collection of member types that are available to use as compositions for the specified member type.",
"operationId": "PostMemberTypeAvailableCompositions",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberTypeCompositionRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableMemberTypeCompositionResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/batch": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets multiple member types.",
"description": "Gets multiple member types identified by the provided Ids.",
"operationId": "GetMemberTypeBatch",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseModelMemberTypeResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/configuration": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets the member type configuration.",
"description": "Gets the configuration settings for member types.",
"operationId": "GetMemberTypeConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberTypeConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/folder": {
"post": {
"tags": [
"Member Type"
],
"summary": "Creates a member type folder.",
"description": "Creates a new member type folder with the provided name and parent location.",
"operationId": "PostMemberTypeFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFolderRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/folder/{id}": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets a member type folder.",
"description": "Gets a member type folder identified by the provided Id.",
"operationId": "GetMemberTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Member Type"
],
"summary": "Deletes a member type folder.",
"description": "Deletes a member type folder identified by the provided Id.",
"operationId": "DeleteMemberTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Member Type"
],
"summary": "Updates a member type folder.",
"description": "Updates a member type folder identified by the provided Id with the details from the request model.",
"operationId": "PutMemberTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFolderResponseModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/member-type/import": {
"post": {
"tags": [
"Member Type"
],
"summary": "Imports a member type.",
"description": "Imports a member type from the provided file upload.",
"operationId": "PostMemberTypeImport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportMemberTypeRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/member-type/ancestors": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets a collection of ancestor member type items.",
"description": "Gets a collection of member type items that are ancestors to the provided Id.",
"operationId": "GetTreeMemberTypeAncestors",
"parameters": [
{
"name": "descendantId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypeTreeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/member-type/children": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets a collection of member type tree child items.",
"description": "Gets a paginated collection of member type tree items that are children of the provided parent Id.",
"operationId": "GetTreeMemberTypeChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedMemberTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/member-type/root": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets a collection of member type items from the root of the tree.",
"description": "Gets a paginated collection of member type items from the root of the tree with optional filtering.",
"operationId": "GetTreeMemberTypeRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedMemberTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/member-type/siblings": {
"get": {
"tags": [
"Member Type"
],
"summary": "Gets sibling member types in the tree.",
"description": "Gets a collection of member type tree items that are siblings of the provided Id.",
"operationId": "GetTreeMemberTypeSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetMemberTypeTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/models-builder/build": {
"post": {
"tags": [
"Models Builder"
],
"summary": "Builds models.",
"description": "Triggers the models builder to generate strongly-typed models for content types.",
"operationId": "PostModelsBuilderBuild",
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"428": {
"description": "Precondition Required",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/models-builder/dashboard": {
"get": {
"tags": [
"Models Builder"
],
"summary": "Gets models builder dashboard data.",
"description": "Gets the dashboard data and current state of the models builder.",
"operationId": "GetModelsBuilderDashboard",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelsBuilderResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/models-builder/status": {
"get": {
"tags": [
"Models Builder"
],
"summary": "Gets models builder status.",
"description": "Gets the current status and configuration of the models builder.",
"operationId": "GetModelsBuilderStatus",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutOfDateStatusResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/news-dashboard": {
"get": {
"tags": [
"News Dashboard"
],
"summary": "Gets news dashboard content.",
"description": "Gets the news dashboard content including recent news items and updates for the Umbraco back office.",
"operationId": "GetNewsDashboard",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewsDashboardResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/object-types": {
"get": {
"tags": [
"Object Types"
],
"summary": "Gets a paginated collection of allowed object types.",
"description": "Gets a paginated collection of object types that are allowed as relation type targets.",
"operationId": "GetObjectTypes",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedObjectTypeResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/oembed/query": {
"get": {
"tags": [
"oEmbed"
],
"summary": "Queries OEmbed information.",
"description": "Queries OEmbed information for the specified URL.",
"operationId": "GetOembedQuery",
"parameters": [
{
"name": "url",
"in": "query",
"schema": {
"type": "string",
"format": "uri"
}
},
{
"name": "maxWidth",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "maxHeight",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OEmbedResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/package/{name}/run-migration": {
"post": {
"tags": [
"Package"
],
"summary": "Runs pending package migrations.",
"description": "Executes all pending package migrations to update the database schema.",
"operationId": "PostPackageByNameRunMigration",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/package/configuration": {
"get": {
"tags": [
"Package"
],
"summary": "Gets the package configuration.",
"description": "Gets the configuration settings for packages.",
"operationId": "GetPackageConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackageConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/package/created": {
"get": {
"tags": [
"Package"
],
"summary": "Gets a paginated collection of created packages.",
"description": "Gets a paginated collection of all created packages.",
"operationId": "GetPackageCreated",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedPackageDefinitionResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"Package"
],
"summary": "Creates a new package.",
"description": "Creates a new package with the configuration specified in the request model.",
"operationId": "PostPackageCreated",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePackageRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/package/created/{id}": {
"get": {
"tags": [
"Package"
],
"summary": "Gets a package.",
"description": "Gets a package identified by the provided Id.",
"operationId": "GetPackageCreatedById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackageDefinitionResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Package"
],
"summary": "Deletes a package.",
"description": "Deletes a package identified by the provided Id.",
"operationId": "DeletePackageCreatedById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Package"
],
"summary": "Updates a package.",
"description": "Updates a package identified by the provided Id with the details from the request model.",
"operationId": "PutPackageCreatedById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePackageRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/package/created/{id}/download": {
"get": {
"tags": [
"Package"
],
"summary": "Downloads a created package.",
"description": "Downloads the package file for the created package identified by the provided Id.",
"operationId": "GetPackageCreatedByIdDownload",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/xml": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/package/migration-status": {
"get": {
"tags": [
"Package"
],
"summary": "Gets all package migration statuses.",
"description": "Gets a paginated collection of migration status for all installed packages.",
"operationId": "GetPackageMigrationStatus",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedPackageMigrationStatusResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/partial-view": {
"get": {
"tags": [
"Partial View"
],
"summary": "Gets a collection of partial view items.",
"description": "Gets a collection of partial view items identified by the provided Ids.",
"operationId": "GetItemPartialView",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartialViewItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/partial-view": {
"post": {
"tags": [
"Partial View"
],
"summary": "Creates a new partial view.",
"description": "Creates a new partial view with the configuration specified in the request model.",
"operationId": "PostPartialView",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePartialViewRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/partial-view/{path}": {
"get": {
"tags": [
"Partial View"
],
"summary": "Gets a partial view by path.",
"description": "Gets a partial view identified by the provided file path.",
"operationId": "GetPartialViewByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartialViewResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Partial View"
],
"summary": "Deletes a partial view.",
"description": "Deletes a partial view identified by the provided Id.",
"operationId": "DeletePartialViewByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Partial View"
],
"summary": "Updates a partial view.",
"description": "Updates a partial view identified by the provided Id with the details from the request model.",
"operationId": "PutPartialViewByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartialViewRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/partial-view/{path}/rename": {
"put": {
"tags": [
"Partial View"
],
"summary": "Renames a partial view.",
"description": "Renames a partial view file to the specified new name.",
"operationId": "PutPartialViewByPathRename",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenamePartialViewRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/partial-view/folder": {
"post": {
"tags": [
"Partial View"
],
"summary": "Creates a partial view folder.",
"description": "Creates a new partial view folder with the provided name and parent location.",
"operationId": "PostPartialViewFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePartialViewFolderRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/partial-view/folder/{path}": {
"get": {
"tags": [
"Partial View"
],
"summary": "Gets a partial view folder by path.",
"description": "Gets a partial view folder identified by the provided file path.",
"operationId": "GetPartialViewFolderByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartialViewFolderResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Partial View"
],
"summary": "Deletes a partial view folder.",
"description": "Deletes a partial view folder identified by the provided Id.",
"operationId": "DeletePartialViewFolderByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/partial-view/snippet": {
"get": {
"tags": [
"Partial View"
],
"summary": "Gets a paginated collection of partial view snippets.",
"description": "Gets a paginated collection of available partial view code snippets that can be used when creating new partial views.",
"operationId": "GetPartialViewSnippet",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedPartialViewSnippetItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/partial-view/snippet/{id}": {
"get": {
"tags": [
"Partial View"
],
"summary": "Gets a partial view snippet.",
"description": "Gets a partial view snippet identified by the provided Id.",
"operationId": "GetPartialViewSnippetById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartialViewSnippetResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/partial-view/ancestors": {
"get": {
"tags": [
"Partial View"
],
"summary": "Gets a collection of ancestor partial view items.",
"description": "Gets a collection of partial view items that are ancestors to the provided Id.",
"operationId": "GetTreePartialViewAncestors",
"parameters": [
{
"name": "descendantPath",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/partial-view/children": {
"get": {
"tags": [
"Partial View"
],
"summary": "Gets a collection of partial view tree child items.",
"description": "Gets a paginated collection of partial view tree items that are children of the provided parent Id.",
"operationId": "GetTreePartialViewChildren",
"parameters": [
{
"name": "parentPath",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/partial-view/root": {
"get": {
"tags": [
"Partial View"
],
"summary": "Gets a collection of partial view items from the root of the tree.",
"description": "Gets a paginated collection of partial view items from the root of the tree with optional filtering.",
"operationId": "GetTreePartialViewRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/partial-view/siblings": {
"get": {
"tags": [
"Partial View"
],
"summary": "Gets a collection of partial view tree sibling items.",
"description": "Gets a collection of partial view tree items that are siblings of the provided Id.",
"operationId": "GetTreePartialViewSiblings",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetFileSystemTreeItemPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/preview": {
"delete": {
"tags": [
"Preview"
],
"summary": "Exits preview mode.",
"description": "Exits preview mode and returns to the normal back office viewing experience.",
"operationId": "DeletePreview",
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": []
}
},
"/umbraco/management/api/v1/profiling/status": {
"get": {
"tags": [
"Profiling"
],
"summary": "Gets profiling status.",
"description": "Gets the current status of the MiniProfiler profiling tool.",
"operationId": "GetProfilingStatus",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfilingStatusResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Profiling"
],
"summary": "Updates the web profiling status.",
"description": "Enables or disables web profiling according to the values provided in the request model.",
"operationId": "PutProfilingStatus",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfilingStatusRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/property-type/is-used": {
"get": {
"tags": [
"Property Type"
],
"summary": "Checks if a property type is used.",
"description": "Checks if the property type identified by the provided content type id and property alias is used in any content, media, or members.",
"operationId": "GetPropertyTypeIsUsed",
"parameters": [
{
"name": "contentTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "propertyAlias",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/published-cache/rebuild": {
"post": {
"tags": [
"Published Cache"
],
"summary": "Rebuilds the published content cache.",
"description": "Rebuilds the entire published content cache from scratch.",
"operationId": "PostPublishedCacheRebuild",
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/published-cache/rebuild/status": {
"get": {
"tags": [
"Published Cache"
],
"summary": "Gets the rebuild cache status.",
"description": "Gets the current status of the published content cache rebuild operation.",
"operationId": "GetPublishedCacheRebuildStatus",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RebuildStatusModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/published-cache/reload": {
"post": {
"tags": [
"Published Cache"
],
"summary": "Reloads the published content cache.",
"description": "Reloads the published content cache from the database.",
"operationId": "PostPublishedCacheReload",
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/redirect-management": {
"get": {
"tags": [
"Redirect Management"
],
"summary": "Gets a paginated collection of redirect URLs.",
"description": "Gets a paginated collection of redirect URLs with support for filtering and sorting.",
"operationId": "GetRedirectManagement",
"parameters": [
{
"name": "filter",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRedirectUrlResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/redirect-management/{id}": {
"get": {
"tags": [
"Redirect Management"
],
"summary": "Gets a redirect URL.",
"description": "Gets a redirect URL identified by the provided Id.",
"operationId": "GetRedirectManagementById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRedirectUrlResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Redirect Management"
],
"summary": "Deletes a redirect URL.",
"description": "Deletes a redirect URL identified by the provided Id.",
"operationId": "DeleteRedirectManagementById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/redirect-management/status": {
"get": {
"tags": [
"Redirect Management"
],
"summary": "Gets the current redirect URL management status.",
"description": "Retrieves the current status and configuration for redirect URL management.",
"operationId": "GetRedirectManagementStatus",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedirectUrlStatusResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"Redirect Management"
],
"summary": "Deprecated. No longer changes the redirect URL tracking status.",
"description": "This endpoint is deprecated and no longer modifies the configuration. To toggle redirect URL tracking, set the Umbraco:CMS:WebRouting:DisableRedirectUrlTracking configuration key instead.",
"operationId": "PostRedirectManagementStatus",
"parameters": [
{
"name": "status",
"in": "query",
"schema": {
"$ref": "#/components/schemas/RedirectStatusModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/relation/type/{id}": {
"get": {
"tags": [
"Relation"
],
"summary": "Gets relations by relation type.",
"description": "Gets a collection of relations filtered by the specified relation type key.",
"operationId": "GetRelationByRelationTypeId",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRelationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/relation-type": {
"get": {
"tags": [
"Relation Type"
],
"summary": "Gets a collection of relation type items.",
"description": "Gets a collection of relation type items identified by the provided Ids.",
"operationId": "GetItemRelationType",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelationTypeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/relation-type": {
"get": {
"tags": [
"Relation Type"
],
"summary": "Gets a paginated collection of relation types.",
"description": "Gets a paginated collection of all relation types configured in the system.",
"operationId": "GetRelationType",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRelationTypeResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/relation-type/{id}": {
"get": {
"tags": [
"Relation Type"
],
"summary": "Gets a relation type.",
"description": "Gets a relation type identified by the provided Id.",
"operationId": "GetRelationTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelationTypeResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/script": {
"get": {
"tags": [
"Script"
],
"summary": "Gets a collection of script items.",
"description": "Gets a collection of script items identified by the provided Ids.",
"operationId": "GetItemScript",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScriptItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/script": {
"post": {
"tags": [
"Script"
],
"summary": "Creates a new script.",
"description": "Creates a new script with the configuration specified in the request model.",
"operationId": "PostScript",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateScriptRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/script/{path}": {
"get": {
"tags": [
"Script"
],
"summary": "Gets a script by path.",
"description": "Gets a script identified by the provided file path.",
"operationId": "GetScriptByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScriptResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Script"
],
"summary": "Deletes a script.",
"description": "Deletes a script identified by the provided file path.",
"operationId": "DeleteScriptByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Script"
],
"summary": "Updates a script.",
"description": "Updates a script identified by the provided Id with the details from the request model.",
"operationId": "PutScriptByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateScriptRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/script/{path}/rename": {
"put": {
"tags": [
"Script"
],
"summary": "Renames a script.",
"description": "Renames a script file to the specified new name.",
"operationId": "PutScriptByPathRename",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenameScriptRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/script/folder": {
"post": {
"tags": [
"Script"
],
"summary": "Creates a script folder.",
"description": "Creates a new script folder with the provided name and parent location.",
"operationId": "PostScriptFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateScriptFolderRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/script/folder/{path}": {
"get": {
"tags": [
"Script"
],
"summary": "Gets a script folder by path.",
"description": "Gets a script folder identified by the provided file path.",
"operationId": "GetScriptFolderByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScriptFolderResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Script"
],
"summary": "Deletes a script folder.",
"description": "Deletes a script folder identified by the provided Id.",
"operationId": "DeleteScriptFolderByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/script/ancestors": {
"get": {
"tags": [
"Script"
],
"summary": "Gets a collection of ancestor script items.",
"description": "Gets a collection of script items that are ancestors to the provided Id.",
"operationId": "GetTreeScriptAncestors",
"parameters": [
{
"name": "descendantPath",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/script/children": {
"get": {
"tags": [
"Script"
],
"summary": "Gets a collection of script tree child items.",
"description": "Gets a paginated collection of script tree items that are children of the provided parent Id.",
"operationId": "GetTreeScriptChildren",
"parameters": [
{
"name": "parentPath",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/script/root": {
"get": {
"tags": [
"Script"
],
"summary": "Gets a collection of script items from the root of the tree.",
"description": "Gets a paginated collection of script items from the root of the tree with optional filtering.",
"operationId": "GetTreeScriptRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/script/siblings": {
"get": {
"tags": [
"Script"
],
"summary": "Gets a collection of script tree sibling items.",
"description": "Gets a collection of script tree items that are siblings of the provided Id.",
"operationId": "GetTreeScriptSiblings",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetFileSystemTreeItemPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/searcher": {
"get": {
"tags": [
"Searcher"
],
"summary": "Gets a collection of searchers.",
"description": "Gets a collection of configured searchers in the Umbraco installation.",
"operationId": "GetSearcher",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedSearcherResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/searcher/{searcherName}/query": {
"get": {
"tags": [
"Searcher"
],
"summary": "Queries a searcher.",
"description": "Queries a named searcher with the provided search term and returns a paginated collection of search results.",
"operationId": "GetSearcherBySearcherNameQuery",
"parameters": [
{
"name": "searcherName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "term",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedSearchResultResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/security/configuration": {
"get": {
"tags": [
"Security"
],
"summary": "Gets the security configuration.",
"description": "Gets the configuration settings for security.",
"operationId": "GetSecurityConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/security/forgot-password": {
"post": {
"tags": [
"Security"
],
"summary": "Requests a password reset.",
"description": "Initiates a password reset process by sending a reset link to the specified email address.",
"operationId": "PostSecurityForgotPassword",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPasswordRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/security/forgot-password/reset": {
"post": {
"tags": [
"Security"
],
"summary": "Initiates password reset.",
"description": "Initiates a password reset process for the user with the provided email.",
"operationId": "PostSecurityForgotPasswordReset",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPasswordTokenRequestModel"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsBuilderModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsBuilderModel"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/security/forgot-password/verify": {
"post": {
"tags": [
"Security"
],
"summary": "Verifies a password reset token.",
"description": "Verifies the provided password reset token for the specified user.",
"operationId": "PostSecurityForgotPasswordVerify",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyResetPasswordTokenRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyResetPasswordResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsBuilderModel"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsBuilderModel"
}
}
}
}
},
"security": []
}
},
"/umbraco/management/api/v1/segment": {
"get": {
"tags": [
"Segment"
],
"summary": "Gets a paginated collection of segments.",
"description": "Gets a paginated collection of segments with support for filtering and pagination.",
"operationId": "GetSegment",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedSegmentResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/server/configuration": {
"get": {
"tags": [
"Server"
],
"summary": "Gets the server configuration.",
"description": "Gets the configuration settings for servers.",
"operationId": "GetServerConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerConfigurationResponseModel"
}
}
}
}
},
"security": []
}
},
"/umbraco/management/api/v1/server/information": {
"get": {
"tags": [
"Server"
],
"summary": "Gets server information.",
"description": "Gets detailed information about the server environment and configuration.",
"operationId": "GetServerInformation",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerInformationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/server/status": {
"get": {
"tags": [
"Server"
],
"summary": "Gets server status.",
"description": "Gets the current operational status of the Umbraco server.",
"operationId": "GetServerStatus",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerStatusResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": []
}
},
"/umbraco/management/api/v1/server/troubleshooting": {
"get": {
"tags": [
"Server"
],
"summary": "Gets server troubleshooting information.",
"description": "Gets troubleshooting information and diagnostics for the server.",
"operationId": "GetServerTroubleshooting",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerTroubleshootingResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/server/upgrade-check": {
"get": {
"tags": [
"Server"
],
"summary": "Checks for available upgrades.",
"description": "Checks if there are any available upgrades for the Umbraco installation.",
"operationId": "GetServerUpgradeCheck",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpgradeCheckResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/static-file": {
"get": {
"tags": [
"Static File"
],
"summary": "Gets a collection of static file items.",
"description": "Gets a collection of static file items identified by the provided Ids.",
"operationId": "GetItemStaticFile",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StaticFileItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/static-file/ancestors": {
"get": {
"tags": [
"Static File"
],
"summary": "Gets a collection of ancestor static file items.",
"description": "Gets a collection of static file items that are ancestors to the provided Id.",
"operationId": "GetTreeStaticFileAncestors",
"parameters": [
{
"name": "descendantPath",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/static-file/children": {
"get": {
"tags": [
"Static File"
],
"summary": "Gets a collection of static file tree child items.",
"description": "Gets a paginated collection of static file tree items that are children of the provided parent Id.",
"operationId": "GetTreeStaticFileChildren",
"parameters": [
{
"name": "parentPath",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/static-file/root": {
"get": {
"tags": [
"Static File"
],
"summary": "Gets a collection of static file items from the root of the tree.",
"description": "Gets a paginated collection of static file items from the root of the tree with optional filtering.",
"operationId": "GetTreeStaticFileRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/stylesheet": {
"get": {
"tags": [
"Stylesheet"
],
"summary": "Gets a collection of stylesheet items.",
"description": "Gets a collection of stylesheet items identified by the provided Ids.",
"operationId": "GetItemStylesheet",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StylesheetItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/stylesheet": {
"post": {
"tags": [
"Stylesheet"
],
"summary": "Creates a new stylesheet.",
"description": "Creates a new stylesheet with the configuration specified in the request model.",
"operationId": "PostStylesheet",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateStylesheetRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/stylesheet/{path}": {
"get": {
"tags": [
"Stylesheet"
],
"summary": "Gets a stylesheet by path.",
"description": "Gets a stylesheet identified by the provided file path.",
"operationId": "GetStylesheetByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StylesheetResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Stylesheet"
],
"summary": "Deletes a stylesheet.",
"description": "Deletes a stylesheet identified by the provided Id.",
"operationId": "DeleteStylesheetByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Stylesheet"
],
"summary": "Updates a stylesheet.",
"description": "Updates a stylesheet identified by the provided Id with the details from the request model.",
"operationId": "PutStylesheetByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStylesheetRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/stylesheet/{path}/rename": {
"put": {
"tags": [
"Stylesheet"
],
"summary": "Renames a stylesheet.",
"description": "Renames a stylesheet file to the specified new name.",
"operationId": "PutStylesheetByPathRename",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenameStylesheetRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/stylesheet/folder": {
"post": {
"tags": [
"Stylesheet"
],
"summary": "Creates a stylesheet folder.",
"description": "Creates a new stylesheet folder with the provided name and parent location.",
"operationId": "PostStylesheetFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateStylesheetFolderRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/stylesheet/folder/{path}": {
"get": {
"tags": [
"Stylesheet"
],
"summary": "Gets a stylesheet folder by path.",
"description": "Gets a stylesheet folder identified by the provided file path.",
"operationId": "GetStylesheetFolderByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StylesheetFolderResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Stylesheet"
],
"summary": "Deletes a stylesheet folder.",
"description": "Deletes a stylesheet folder identified by the provided Id.",
"operationId": "DeleteStylesheetFolderByPath",
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/stylesheet/ancestors": {
"get": {
"tags": [
"Stylesheet"
],
"summary": "Gets a collection of ancestor stylesheet items.",
"description": "Gets a collection of stylesheet items that are ancestors to the provided Id.",
"operationId": "GetTreeStylesheetAncestors",
"parameters": [
{
"name": "descendantPath",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/stylesheet/children": {
"get": {
"tags": [
"Stylesheet"
],
"summary": "Gets a collection of stylesheet tree child items.",
"description": "Gets a paginated collection of stylesheet tree items that are children of the provided parent Id.",
"operationId": "GetTreeStylesheetChildren",
"parameters": [
{
"name": "parentPath",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/stylesheet/root": {
"get": {
"tags": [
"Stylesheet"
],
"summary": "Gets a collection of stylesheet items from the root of the tree.",
"description": "Gets a paginated collection of stylesheet items from the root of the tree with optional filtering.",
"operationId": "GetTreeStylesheetRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/stylesheet/siblings": {
"get": {
"tags": [
"Stylesheet"
],
"summary": "Gets a collection of stylesheet tree sibling items.",
"description": "Gets a collection of stylesheet tree items that are siblings of the provided Id.",
"operationId": "GetTreeStylesheetSiblings",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetFileSystemTreeItemPresentationModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tag": {
"get": {
"tags": [
"Tag"
],
"summary": "Gets a collection of tags.",
"description": "Gets a collection of tags filtered by the provided query string.",
"operationId": "GetTag",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "tagGroup",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedTagResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/telemetry": {
"get": {
"tags": [
"Telemetry"
],
"summary": "Gets telemetry data.",
"description": "Gets telemetry data and statistics for the Umbraco installation.",
"operationId": "GetTelemetry",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedTelemetryResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/telemetry/level": {
"get": {
"tags": [
"Telemetry"
],
"summary": "Gets telemetry information.",
"description": "Gets the current telemetry configuration and consent level.",
"operationId": "GetTelemetryLevel",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelemetryResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"Telemetry"
],
"summary": "Sets telemetry consent level.",
"description": "Sets the telemetry consent level for anonymous usage data collection.",
"operationId": "PostTelemetryLevel",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelemetryRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/template": {
"get": {
"tags": [
"Template"
],
"summary": "Gets a collection of template items.",
"description": "Gets a collection of template items identified by the provided Ids.",
"operationId": "GetItemTemplate",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/template/ancestors": {
"get": {
"tags": [
"Template"
],
"summary": "Gets ancestors for a collection of template items.",
"description": "Gets the ancestor chains for template items identified by the provided Ids.",
"operationId": "GetItemTemplateAncestors",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemAncestorsResponseModelTemplateItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/template/search": {
"get": {
"tags": [
"Template"
],
"summary": "Searches template items.",
"description": "Searches template items by the provided query with pagination support.",
"operationId": "GetItemTemplateSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedModelTemplateItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/template": {
"post": {
"tags": [
"Template"
],
"summary": "Creates a new template.",
"description": "Creates a new template with the configuration specified in the request model.",
"operationId": "PostTemplate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTemplateRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/template/{id}": {
"get": {
"tags": [
"Template"
],
"summary": "Gets a template.",
"description": "Gets a template identified by the provided Id.",
"operationId": "GetTemplateById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Template"
],
"summary": "Deletes a template.",
"description": "Deletes a template identified by the provided Id.",
"operationId": "DeleteTemplateById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Template"
],
"summary": "Updates a template.",
"description": "Updates a template identified by the provided Id with the details from the request model.",
"operationId": "PutTemplateById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTemplateRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/template/configuration": {
"get": {
"tags": [
"Template"
],
"summary": "Gets the template configuration.",
"description": "Gets the configuration settings for templates.",
"operationId": "GetTemplateConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/template/query/execute": {
"post": {
"tags": [
"Template"
],
"summary": "Executes a template query.",
"description": "Executes a template query with the provided parameters and returns the matching content results with execution metrics.",
"operationId": "PostTemplateQueryExecute",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateQueryExecuteModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateQueryResultResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/template/query/settings": {
"get": {
"tags": [
"Template"
],
"summary": "Gets template query settings.",
"description": "Gets the available configuration settings for template queries including document type aliases, properties, and operators.",
"operationId": "GetTemplateQuerySettings",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateQuerySettingsResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/template/ancestors": {
"get": {
"tags": [
"Template"
],
"summary": "Gets a collection of ancestor template items.",
"description": "Gets a collection of template items that are ancestors to the provided Id.",
"operationId": "GetTreeTemplateAncestors",
"parameters": [
{
"name": "descendantId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NamedEntityTreeItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/template/children": {
"get": {
"tags": [
"Template"
],
"summary": "Gets a collection of template tree child items.",
"description": "Gets a paginated collection of template tree items that are children of the provided parent Id.",
"operationId": "GetTreeTemplateChildren",
"parameters": [
{
"name": "parentId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedNamedEntityTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/template/root": {
"get": {
"tags": [
"Template"
],
"summary": "Gets a collection of template items from the root of the tree.",
"description": "Gets a paginated collection of template items from the root of the tree with optional filtering.",
"operationId": "GetTreeTemplateRoot",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedNamedEntityTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/tree/template/siblings": {
"get": {
"tags": [
"Template"
],
"summary": "Gets a collection of template tree sibling items.",
"description": "Gets a collection of template tree items that are siblings of the provided Id.",
"operationId": "GetTreeTemplateSiblings",
"parameters": [
{
"name": "target",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "before",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "after",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubsetNamedEntityTreeItemResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/temporary-file": {
"post": {
"tags": [
"Temporary File"
],
"summary": "Creates a temporary file.",
"description": "Uploads and creates a temporary file that can be used in subsequent operations.",
"operationId": "PostTemporaryFile",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"format": "uuid"
},
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/temporary-file/{id}": {
"get": {
"tags": [
"Temporary File"
],
"summary": "Gets a temporary file.",
"description": "Gets a temporary file identified by the provided Id.",
"operationId": "GetTemporaryFileById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemporaryFileResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Temporary File"
],
"summary": "Deletes a temporary file.",
"description": "Deletes a temporary file identified by the provided Id.",
"operationId": "DeleteTemporaryFileById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/temporary-file/configuration": {
"get": {
"tags": [
"Temporary File"
],
"summary": "Gets the temporary file configuration.",
"description": "Gets the configuration settings for temporary files.",
"operationId": "GetTemporaryFileConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemporaryFileConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/upgrade/authorize": {
"post": {
"tags": [
"Upgrade"
],
"summary": "Authorizes the upgrade.",
"description": "Authorizes the currently authenticated user to perform the upgrade.",
"operationId": "PostUpgradeAuthorize",
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"428": {
"description": "Precondition Required",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/upgrade/settings": {
"get": {
"tags": [
"Upgrade"
],
"summary": "Gets upgrade settings.",
"description": "Gets the current upgrade settings and status for the Umbraco installation.",
"operationId": "GetUpgradeSettings",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpgradeSettingsResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"428": {
"description": "Precondition Required",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/filter/user": {
"get": {
"tags": [
"User"
],
"summary": "Gets a filtered collection of users.",
"description": "Filters users based on the provided criteria with support for pagination.",
"operationId": "GetFilterUser",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "orderBy",
"in": "query",
"schema": {
"default": "UserName",
"$ref": "#/components/schemas/UserOrderModel"
}
},
{
"name": "orderDirection",
"in": "query",
"schema": {
"default": "Ascending",
"$ref": "#/components/schemas/DirectionModel"
}
},
{
"name": "userGroupIds",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "userStates",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserStateModel"
}
}
},
{
"name": "filter",
"in": "query",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedUserResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/user": {
"get": {
"tags": [
"User"
],
"summary": "Gets a collection of user items.",
"description": "Gets a collection of user items identified by the provided Ids.",
"operationId": "GetItemUser",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user": {
"delete": {
"tags": [
"User"
],
"summary": "Deletes multiple users.",
"description": "Deletes multiple users identified by the provided Ids. This operation cannot be undone.",
"operationId": "DeleteUser",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteUsersRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"User"
],
"summary": "Creates a new user.",
"description": "Creates a new user with the configuration specified in the request model.",
"operationId": "PostUser",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"get": {
"tags": [
"User"
],
"summary": "Gets a paginated collection of users.",
"description": "Gets a paginated collection of all users.",
"operationId": "GetUser",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedUserResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/{id}": {
"get": {
"tags": [
"User"
],
"summary": "Gets a user.",
"description": "Gets a user identified by the provided Id.",
"operationId": "GetUserById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"User"
],
"summary": "Deletes a user.",
"description": "Deletes a user identified by the provided Id.",
"operationId": "DeleteUserById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"User"
],
"summary": "Updates a user.",
"description": "Updates a user identified by the provided Id with the details from the request model.",
"operationId": "PutUserById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/{id}/2fa": {
"get": {
"tags": [
"User"
],
"summary": "Lists two-factor providers for a user.",
"description": "Gets a list of available two-factor authentication providers for the specified user.",
"operationId": "GetUserById2fa",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserTwoFactorProviderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/{id}/2fa/{providerName}": {
"delete": {
"tags": [
"User"
],
"summary": "Disables two-factor authentication for a user.",
"description": "Disables the specified two-factor authentication provider for a user.",
"operationId": "DeleteUserById2faByProviderName",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "providerName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/{id}/calculate-start-nodes": {
"get": {
"tags": [
"User"
],
"summary": "Calculates start nodes for users.",
"description": "Calculates the start nodes for the users identified by the provided Ids based on their permissions.",
"operationId": "GetUserByIdCalculateStartNodes",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalculatedUserStartNodesResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/{id}/change-password": {
"post": {
"tags": [
"User"
],
"summary": "Changes a user's password.",
"description": "Changes the password for the user identified by the provided Id.",
"operationId": "PostUserByIdChangePassword",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangePasswordUserRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/{id}/client-credentials": {
"post": {
"tags": [
"User"
],
"summary": "Creates client credentials for a user.",
"description": "Creates OAuth client credentials for the user identified by the provided Id.",
"operationId": "PostUserByIdClientCredentials",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserClientCredentialsRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"get": {
"tags": [
"User"
],
"summary": "Gets all client credentials for a user.",
"description": "Gets a collection of OAuth client credentials for the user identified by the provided Id.",
"operationId": "GetUserByIdClientCredentials",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/{id}/client-credentials/{clientId}": {
"delete": {
"tags": [
"User"
],
"summary": "Deletes client credentials for a user.",
"description": "Deletes client credentials identified by the provided client Id for a user.",
"operationId": "DeleteUserByIdClientCredentialsByClientId",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "clientId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/{id}/reset-password": {
"post": {
"tags": [
"User"
],
"summary": "Resets a user's password.",
"description": "Resets the password for the user using the provided reset token.",
"operationId": "PostUserByIdResetPassword",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPasswordUserResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/avatar/{id}": {
"delete": {
"tags": [
"User"
],
"summary": "Clears a user's avatar.",
"description": "Removes the avatar image for the user identified by the provided Id.",
"operationId": "DeleteUserAvatarById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"User"
],
"summary": "Sets a user's avatar.",
"description": "Sets or updates the avatar image for the user identified by the provided Id.",
"operationId": "PostUserAvatarById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetAvatarRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/batch": {
"get": {
"tags": [
"User"
],
"summary": "Gets multiple users.",
"description": "Gets multiple users identified by the provided Ids.",
"operationId": "GetUserBatch",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchResponseModelUserResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/configuration": {
"get": {
"tags": [
"User"
],
"summary": "Gets the user configuration.",
"description": "Gets the configuration settings for users.",
"operationId": "GetUserConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current": {
"get": {
"tags": [
"User"
],
"summary": "Gets the current user.",
"description": "Gets the currently authenticated back office user's information and permissions.",
"operationId": "GetUserCurrent",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrentUserResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current/2fa": {
"get": {
"tags": [
"User"
],
"summary": "Lists two-factor providers for the current user.",
"description": "Gets a list of available two-factor authentication providers for the current user.",
"operationId": "GetUserCurrent2fa",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserTwoFactorProviderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current/2fa/{providerName}": {
"delete": {
"tags": [
"User"
],
"summary": "Disables two-factor authentication for the current user.",
"description": "Disables the specified two-factor authentication provider for the currently authenticated user.",
"operationId": "DeleteUserCurrent2faByProviderName",
"parameters": [
{
"name": "providerName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "code",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"User"
],
"summary": "Enables two-factor authentication for the current user.",
"description": "Enables the specified two-factor authentication provider for the currently authenticated user.",
"operationId": "PostUserCurrent2faByProviderName",
"parameters": [
{
"name": "providerName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnableTwoFactorRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ISetupTwoFactorModel"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"get": {
"tags": [
"User"
],
"summary": "Gets two-factor setup information.",
"description": "Gets the setup information for configuring a two-factor authentication provider.",
"operationId": "GetUserCurrent2faByProviderName",
"parameters": [
{
"name": "providerName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ISetupTwoFactorModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current/avatar": {
"delete": {
"tags": [
"User"
],
"summary": "Clears the current user's avatar.",
"description": "Removes the avatar image for the currently authenticated user.",
"operationId": "DeleteUserCurrentAvatar",
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"User"
],
"summary": "Sets the current user's avatar.",
"description": "Sets or updates the avatar image for the currently authenticated user.",
"operationId": "PostUserCurrentAvatar",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetAvatarRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current/change-password": {
"post": {
"tags": [
"User"
],
"summary": "Changes the current user's password.",
"description": "Changes the password for the currently authenticated user.",
"operationId": "PostUserCurrentChangePassword",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangePasswordCurrentUserRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current/configuration": {
"get": {
"tags": [
"User"
],
"summary": "Gets the current user's configuration.",
"description": "Gets the configuration settings for the current user.",
"operationId": "GetUserCurrentConfiguration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrentUserConfigurationResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current/login-providers": {
"get": {
"tags": [
"User"
],
"summary": "Lists external login providers.",
"description": "Gets a list of configured external login providers for authentication.",
"operationId": "GetUserCurrentLoginProviders",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserExternalLoginProviderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current/permissions": {
"get": {
"tags": [
"User"
],
"summary": "Gets permissions for the current user.",
"description": "Gets the permissions for the currently authenticated user.",
"operationId": "GetUserCurrentPermissions",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPermissionsResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current/permissions/document": {
"get": {
"tags": [
"User"
],
"summary": "Gets document permissions for the current user.",
"description": "Gets the document permissions for the currently authenticated user.",
"operationId": "GetUserCurrentPermissionsDocument",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPermissionsResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current/permissions/element": {
"get": {
"tags": [
"User"
],
"summary": "Gets element permissions for the current user.",
"description": "Gets the element permissions for the currently authenticated user.",
"operationId": "GetUserCurrentPermissionsElement",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPermissionsResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current/permissions/media": {
"get": {
"tags": [
"User"
],
"summary": "Gets media permissions for the current user.",
"description": "Gets the media permissions for the currently authenticated user.",
"operationId": "GetUserCurrentPermissionsMedia",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPermissionsResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/current/profile": {
"put": {
"tags": [
"User"
],
"summary": "Updates current user profile.",
"description": "Updates current user profile with the details from the request model.",
"operationId": "PutUserCurrentProfile",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCurrentUserRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/disable": {
"post": {
"tags": [
"User"
],
"summary": "Disables users.",
"description": "Disables the user accounts identified by the provided Ids.",
"operationId": "PostUserDisable",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisableUserRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/enable": {
"post": {
"tags": [
"User"
],
"summary": "Enables users.",
"description": "Enables the user accounts identified by the provided Ids.",
"operationId": "PostUserEnable",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnableUserRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/invite": {
"post": {
"tags": [
"User"
],
"summary": "Invites new users.",
"description": "Sends invitation emails to create new user accounts with the specified details.",
"operationId": "PostUserInvite",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InviteUserRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/invite/create-password": {
"post": {
"tags": [
"User"
],
"summary": "Creates an initial password for a user.",
"description": "Creates an initial password for a newly invited user using the provided token.",
"operationId": "PostUserInviteCreatePassword",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateInitialPasswordUserRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": []
}
},
"/umbraco/management/api/v1/user/invite/resend": {
"post": {
"tags": [
"User"
],
"summary": "Resends a user invitation.",
"description": "Resends the invitation email for the users identified by the provided Ids.",
"operationId": "PostUserInviteResend",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResendInviteUserRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/invite/verify": {
"post": {
"tags": [
"User"
],
"summary": "Verifies a user invitation.",
"description": "Verifies that the invitation token is valid for creating a new user account.",
"operationId": "PostUserInviteVerify",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyInviteUserRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyInviteUserResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": []
}
},
"/umbraco/management/api/v1/user/set-user-groups": {
"post": {
"tags": [
"User"
],
"summary": "Updates user group assignments.",
"description": "Updates the user group assignments for the specified users.",
"operationId": "PostUserSetUserGroups",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserGroupsOnUserRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user/unlock": {
"post": {
"tags": [
"User"
],
"summary": "Unlocks users.",
"description": "Unlocks the user accounts identified by the provided Ids.",
"operationId": "PostUserUnlock",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnlockUsersRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user-data": {
"post": {
"tags": [
"User Data"
],
"summary": "Creates user data.",
"description": "Creates user-specific data for the current authenticated user with the provided key and value.",
"operationId": "PostUserData",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserDataRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDataOperationStatusModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDataOperationStatusModel"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"get": {
"tags": [
"User Data"
],
"summary": "Gets user data.",
"description": "Gets user-specific data stored for the current authenticated user.",
"operationId": "GetUserData",
"parameters": [
{
"name": "groups",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "identifiers",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedUserDataResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"User Data"
],
"summary": "Updates user data.",
"description": "Updates user-specific data for the current authenticated user.",
"operationId": "PutUserData",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserDataRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDataOperationStatusModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDataOperationStatusModel"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user-data/{id}": {
"get": {
"tags": [
"User Data"
],
"summary": "Gets user data.",
"description": "Gets user data identified by the provided Id.",
"operationId": "GetUserDataById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDataModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"User Data"
],
"summary": "Deletes user data.",
"description": "Deletes user data identified by the provided Id.",
"operationId": "DeleteUserDataById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDataOperationStatusModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDataOperationStatusModel"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/filter/user-group": {
"get": {
"tags": [
"User Group"
],
"summary": "Gets a filtered collection of user groups.",
"description": "Filters user groups based on the provided criteria with support for pagination.",
"operationId": "GetFilterUserGroup",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "filter",
"in": "query",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedUserGroupResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/user-group": {
"get": {
"tags": [
"User Group"
],
"summary": "Gets a collection of user group items.",
"description": "Gets a collection of user group items identified by the provided Ids.",
"operationId": "GetItemUserGroup",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserGroupItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user-group": {
"delete": {
"tags": [
"User Group"
],
"summary": "Deletes multiple user groups.",
"description": "Deletes multiple user groups identified by the provided Ids. This operation cannot be undone.",
"operationId": "DeleteUserGroup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteUserGroupsRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"User Group"
],
"summary": "Creates a new user group.",
"description": "Creates a new user group with the configuration specified in the request model.",
"operationId": "PostUserGroup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserGroupRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"get": {
"tags": [
"User Group"
],
"summary": "Gets a paginated collection of user groups.",
"description": "Gets a paginated collection of all user groups.",
"operationId": "GetUserGroup",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedUserGroupResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user-group/{id}": {
"get": {
"tags": [
"User Group"
],
"summary": "Gets a user group.",
"description": "Gets a user group identified by the provided Id.",
"operationId": "GetUserGroupById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGroupResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"User Group"
],
"summary": "Deletes a user group.",
"description": "Deletes a user group identified by the provided Id.",
"operationId": "DeleteUserGroupById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"User Group"
],
"summary": "Updates a user group.",
"description": "Updates a user group identified by the provided Id with the details from the request model.",
"operationId": "PutUserGroupById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserGroupRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/user-group/{id}/users": {
"post": {
"tags": [
"User Group"
],
"summary": "Adds users to a user group.",
"description": "Adds the specified users to the user group identified by the provided Id.",
"operationId": "PostUserGroupByIdUsers",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"User Group"
],
"summary": "Removes users from a user group.",
"description": "Removes the specified users from the user group identified by the provided Id.",
"operationId": "DeleteUserGroupByIdUsers",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/item/webhook": {
"get": {
"tags": [
"Webhook"
],
"summary": "Gets a collection of webhook items.",
"description": "Gets a collection of webhook items identified by the provided Ids.",
"operationId": "GetItemWebhook",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookItemResponseModel"
}
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/webhook": {
"get": {
"tags": [
"Webhook"
],
"summary": "Gets a paginated collection of webhooks.",
"description": "Gets a paginated collection of all webhooks.",
"operationId": "GetWebhook",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedWebhookResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"post": {
"tags": [
"Webhook"
],
"summary": "Creates a new webhook.",
"description": "Creates a new webhook with the configuration specified in the request model.",
"operationId": "PostWebhook",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWebhookRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Umb-Generated-Resource": {
"description": "Identifier of the newly created resource",
"schema": {
"type": "string",
"description": "Identifier of the newly created resource"
}
},
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
},
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/webhook/{id}": {
"get": {
"tags": [
"Webhook"
],
"summary": "Gets a webhook.",
"description": "Gets a webhook identified by the provided Id.",
"operationId": "GetWebhookById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"delete": {
"tags": [
"Webhook"
],
"summary": "Deletes a webhook.",
"description": "Deletes a webhook identified by the provided Id.",
"operationId": "DeleteWebhookById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
},
"put": {
"tags": [
"Webhook"
],
"summary": "Updates a webhook.",
"description": "Updates a webhook identified by the provided Id with the details from the request model.",
"operationId": "PutWebhookById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWebhookRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Umb-Notifications": {
"description": "The list of notifications produced during the request.",
"schema": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/NotificationHeaderModel"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/webhook/{id}/logs": {
"get": {
"tags": [
"Webhook"
],
"summary": "Gets a paginated collection of webhook logs for a specific webhook.",
"description": "Gets a paginated collection of webhook logs for the webhook identified by the provided Id.",
"operationId": "GetWebhookByIdLogs",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedWebhookLogResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/webhook/events": {
"get": {
"tags": [
"Webhook"
],
"summary": "Gets a paginated collection of webhook events.",
"description": "Gets a paginated collection of available webhook events that can be subscribed to.",
"operationId": "GetWebhookEvents",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedWebhookEventModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
},
"/umbraco/management/api/v1/webhook/logs": {
"get": {
"tags": [
"Webhook"
],
"summary": "Gets a paginated collection of webhook logs.",
"description": "Gets a paginated collection of webhook logs for all webhooks.",
"operationId": "GetWebhookLogs",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedWebhookLogResponseModel"
}
}
}
},
"401": {
"description": "The resource is protected and requires an authentication token"
},
"403": {
"description": "The authenticated user does not have access to this resource"
}
},
"security": [
{
"Backoffice-User": []
}
]
}
}
},
"components": {
"schemas": {
"AllowedDocumentTypeModel": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": [
"null",
"string"
]
}
}
},
"AllowedMediaTypeItemResponseModel": {
"required": [
"matchedFileExtension",
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"matchedFileExtension": {
"type": "boolean"
},
"icon": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"AllowedMediaTypeModel": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": [
"null",
"string"
]
}
}
},
"AllowedMemberTypeModel": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": [
"null",
"string"
]
}
}
},
"AuditLogResponseModel": {
"required": [
"user",
"timestamp",
"logType"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"logType": {
"$ref": "#/components/schemas/AuditTypeModel"
},
"comment": {
"type": [
"null",
"string"
]
},
"parameters": {
"type": [
"null",
"string"
]
}
}
},
"AuditTypeModel": {
"enum": [
"New",
"Save",
"SaveVariant",
"Open",
"Delete",
"Publish",
"PublishVariant",
"SendToPublish",
"SendToPublishVariant",
"Unpublish",
"UnpublishVariant",
"Move",
"Copy",
"AssignDomain",
"PublicAccess",
"Sort",
"Notify",
"System",
"RollBack",
"PackagerInstall",
"PackagerUninstall",
"Custom",
"ContentVersionPreventCleanup",
"ContentVersionEnableCleanup"
]
},
"AvailableDocumentTypeCompositionResponseModel": {
"required": [
"folderPath",
"isCompatible",
"id",
"name",
"icon"
],
"type": "object",
"properties": {
"folderPath": {
"type": "array",
"items": {
"type": "string"
}
},
"isCompatible": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
}
}
},
"AvailableMediaTypeCompositionResponseModel": {
"required": [
"folderPath",
"isCompatible",
"id",
"name",
"icon"
],
"type": "object",
"properties": {
"folderPath": {
"type": "array",
"items": {
"type": "string"
}
},
"isCompatible": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
}
}
},
"AvailableMemberTypeCompositionResponseModel": {
"required": [
"folderPath",
"isCompatible",
"id",
"name",
"icon"
],
"type": "object",
"properties": {
"folderPath": {
"type": "array",
"items": {
"type": "string"
}
},
"isCompatible": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
}
}
},
"BatchResponseModelDataTypeResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypeResponseModel"
}
}
}
},
"BatchResponseModelDocumentTypeResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeResponseModel"
}
}
}
},
"BatchResponseModelMediaTypeResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeResponseModel"
}
}
}
},
"BatchResponseModelMemberTypeResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypeResponseModel"
}
}
}
},
"BatchResponseModelUserResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponseModel"
}
}
}
},
"CalculatedUserStartNodesResponseModel": {
"required": [
"id",
"documentStartNodeIds",
"hasDocumentRootAccess",
"mediaStartNodeIds",
"hasMediaRootAccess",
"elementStartNodeIds",
"hasElementRootAccess"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"documentStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasDocumentRootAccess": {
"type": "boolean"
},
"mediaStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasMediaRootAccess": {
"type": "boolean"
},
"elementStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasElementRootAccess": {
"type": "boolean"
}
}
},
"ChangePasswordCurrentUserRequestModel": {
"required": [
"newPassword"
],
"type": "object",
"properties": {
"oldPassword": {
"type": [
"null",
"string"
]
},
"newPassword": {
"type": "string"
}
}
},
"ChangePasswordUserRequestModel": {
"required": [
"newPassword"
],
"type": "object",
"properties": {
"newPassword": {
"type": "string"
}
}
},
"CompositionTypeModel": {
"enum": [
"Composition",
"Inheritance"
]
},
"ConsentLevelPresentationModel": {
"required": [
"description",
"level"
],
"type": "object",
"properties": {
"level": {
"$ref": "#/components/schemas/TelemetryLevelModel"
},
"description": {
"type": "string"
}
}
},
"ContentSortFieldModel": {
"enum": [
"Name",
"CreateDate",
"UpdateDate"
]
},
"CopyDataTypeRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"CopyDocumentRequestModel": {
"required": [
"relateToOriginal",
"includeDescendants"
],
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"relateToOriginal": {
"type": "boolean"
},
"includeDescendants": {
"type": "boolean"
}
}
},
"CopyDocumentTypeRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"CopyElementRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"CopyMediaTypeRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"CopyMemberTypeRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"CreateAndPublishDocumentRequestModel": {
"required": [
"template",
"documentType",
"culturesToPublish",
"values",
"variants"
],
"type": "object",
"properties": {
"culturesToPublish": {
"type": "array",
"items": {
"type": "string"
}
},
"template": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"documentType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantRequestModel"
}
}
}
},
"CreateAndPublishElementRequestModel": {
"required": [
"documentType",
"culturesToPublish",
"values",
"variants"
],
"type": "object",
"properties": {
"culturesToPublish": {
"type": "array",
"items": {
"type": "string"
}
},
"documentType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantRequestModel"
}
}
}
},
"CreateDataTypeRequestModel": {
"required": [
"name",
"editorAlias",
"editorUiAlias",
"values"
],
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": "string"
},
"editorAlias": {
"type": "string"
},
"editorUiAlias": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypePropertyPresentationModel"
}
}
}
},
"CreateDictionaryItemRequestModel": {
"required": [
"name",
"translations"
],
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": "string"
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryItemTranslationModel"
}
}
}
},
"CreateDocumentBlueprintFromDocumentRequestModel": {
"required": [
"document",
"name"
],
"type": "object",
"properties": {
"document": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"CreateDocumentBlueprintRequestModel": {
"required": [
"documentType",
"values",
"variants"
],
"type": "object",
"properties": {
"documentType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantRequestModel"
}
}
}
},
"CreateDocumentRequestModel": {
"required": [
"template",
"documentType",
"values",
"variants"
],
"type": "object",
"properties": {
"template": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"documentType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantRequestModel"
}
}
}
},
"CreateDocumentTypePropertyTypeContainerRequestModel": {
"required": [
"type",
"id",
"sortOrder"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": [
"null",
"string"
]
},
"type": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"CreateDocumentTypePropertyTypeRequestModel": {
"required": [
"alias",
"name",
"id",
"sortOrder",
"dataType",
"variesByCulture",
"variesBySegment",
"validation",
"appearance"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"container": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"dataType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"validation": {
"$ref": "#/components/schemas/PropertyTypeValidationModel"
},
"appearance": {
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
}
}
},
"CreateDocumentTypeRequestModel": {
"required": [
"alias",
"name",
"icon",
"properties",
"allowedTemplates",
"cleanup",
"allowedDocumentTypes",
"compositions",
"allowedAsRoot",
"variesByCulture",
"variesBySegment",
"isElement",
"allowedInLibrary",
"containers"
],
"type": "object",
"properties": {
"allowedTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"defaultTemplate": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"cleanup": {
"$ref": "#/components/schemas/DocumentTypeCleanupModel"
},
"allowedDocumentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeSortModel"
}
},
"compositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeCompositionModel"
}
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"isElement": {
"type": "boolean"
},
"allowedInLibrary": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateDocumentTypePropertyTypeRequestModel"
}
},
"containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateDocumentTypePropertyTypeContainerRequestModel"
}
}
}
},
"CreateDocumentTypeTemplateRequestModel": {
"required": [
"alias",
"name",
"isDefault"
],
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
}
},
"CreateElementRequestModel": {
"required": [
"documentType",
"values",
"variants"
],
"type": "object",
"properties": {
"documentType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantRequestModel"
}
}
}
},
"CreateFolderRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": "string"
}
}
},
"CreateInitialPasswordUserRequestModel": {
"required": [
"user",
"token",
"password"
],
"type": "object",
"properties": {
"password": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"token": {
"type": "string"
}
}
},
"CreateLanguageRequestModel": {
"required": [
"isoCode",
"name",
"isDefault",
"isMandatory"
],
"type": "object",
"properties": {
"isoCode": {
"type": "string"
},
"name": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"isMandatory": {
"type": "boolean"
},
"fallbackIsoCode": {
"type": [
"null",
"string"
]
}
}
},
"CreateMediaRequestModel": {
"required": [
"mediaType",
"values",
"variants"
],
"type": "object",
"properties": {
"mediaType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaVariantRequestModel"
}
}
}
},
"CreateMediaTypePropertyTypeContainerRequestModel": {
"required": [
"type",
"id",
"sortOrder"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": [
"null",
"string"
]
},
"type": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"CreateMediaTypePropertyTypeRequestModel": {
"required": [
"alias",
"name",
"id",
"sortOrder",
"dataType",
"variesByCulture",
"variesBySegment",
"validation",
"appearance"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"container": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"dataType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"validation": {
"$ref": "#/components/schemas/PropertyTypeValidationModel"
},
"appearance": {
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
}
}
},
"CreateMediaTypeRequestModel": {
"required": [
"alias",
"name",
"icon",
"properties",
"allowedMediaTypes",
"compositions",
"allowedAsRoot",
"variesByCulture",
"variesBySegment",
"isElement",
"allowedInLibrary",
"containers"
],
"type": "object",
"properties": {
"allowedMediaTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeSortModel"
}
},
"compositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeCompositionModel"
}
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"isElement": {
"type": "boolean"
},
"allowedInLibrary": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateMediaTypePropertyTypeRequestModel"
}
},
"containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateMediaTypePropertyTypeContainerRequestModel"
}
}
}
},
"CreateMemberGroupRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"name": {
"type": "string"
}
}
},
"CreateMemberRequestModel": {
"required": [
"memberType",
"email",
"username",
"password",
"isApproved",
"values",
"variants"
],
"type": "object",
"properties": {
"email": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"memberType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"groups": {
"type": [
"null",
"array"
],
"items": {
"type": "string",
"format": "uuid"
}
},
"isApproved": {
"type": "boolean"
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberVariantRequestModel"
}
}
}
},
"CreateMemberTypePropertyTypeContainerRequestModel": {
"required": [
"type",
"id",
"sortOrder"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": [
"null",
"string"
]
},
"type": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"CreateMemberTypePropertyTypeRequestModel": {
"required": [
"alias",
"name",
"isSensitive",
"visibility",
"id",
"sortOrder",
"dataType",
"variesByCulture",
"variesBySegment",
"validation",
"appearance"
],
"type": "object",
"properties": {
"isSensitive": {
"type": "boolean"
},
"visibility": {
"$ref": "#/components/schemas/MemberTypePropertyTypeVisibilityModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"container": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"dataType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"validation": {
"$ref": "#/components/schemas/PropertyTypeValidationModel"
},
"appearance": {
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
}
}
},
"CreateMemberTypeRequestModel": {
"required": [
"alias",
"name",
"icon",
"properties",
"compositions",
"allowedAsRoot",
"variesByCulture",
"variesBySegment",
"isElement",
"allowedInLibrary",
"containers"
],
"type": "object",
"properties": {
"compositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypeCompositionModel"
}
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"isElement": {
"type": "boolean"
},
"allowedInLibrary": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateMemberTypePropertyTypeRequestModel"
}
},
"containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateMemberTypePropertyTypeContainerRequestModel"
}
}
}
},
"CreatePackageRequestModel": {
"required": [
"name",
"contentLoadChildNodes",
"mediaIds",
"mediaLoadChildNodes",
"documentTypes",
"mediaTypes",
"dataTypes",
"templates",
"partialViews",
"stylesheets",
"scripts",
"languages",
"dictionaryItems"
],
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"name": {
"type": "string"
},
"contentNodeId": {
"type": [
"null",
"string"
]
},
"contentLoadChildNodes": {
"type": "boolean"
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"mediaLoadChildNodes": {
"type": "boolean"
},
"elementIds": {
"type": [
"null",
"array"
],
"items": {
"type": "string",
"format": "uuid"
}
},
"documentTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"mediaTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"dataTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"templates": {
"type": "array",
"items": {
"type": "string"
}
},
"partialViews": {
"type": "array",
"items": {
"type": "string"
}
},
"stylesheets": {
"type": "array",
"items": {
"type": "string"
}
},
"scripts": {
"type": "array",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"dictionaryItems": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CreatePartialViewFolderRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
}
}
},
"CreatePartialViewRequestModel": {
"required": [
"content",
"name"
],
"type": "object",
"properties": {
"content": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
}
}
},
"CreateScriptFolderRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
}
}
},
"CreateScriptRequestModel": {
"required": [
"content",
"name"
],
"type": "object",
"properties": {
"content": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
}
}
},
"CreateStylesheetFolderRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
}
}
},
"CreateStylesheetRequestModel": {
"required": [
"content",
"name"
],
"type": "object",
"properties": {
"content": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
}
}
},
"CreateTemplateRequestModel": {
"required": [
"name",
"alias"
],
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"content": {
"type": [
"null",
"string"
]
}
}
},
"CreateUserClientCredentialsRequestModel": {
"required": [
"clientId",
"clientSecret"
],
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
}
}
},
"CreateUserDataRequestModel": {
"required": [
"group",
"identifier",
"value"
],
"type": "object",
"properties": {
"key": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"group": {
"type": "string"
},
"identifier": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"CreateUserGroupRequestModel": {
"required": [
"name",
"alias",
"sections",
"languages",
"hasAccessToAllLanguages",
"fallbackPermissions",
"permissions",
"documentRootAccess",
"mediaRootAccess",
"elementRootAccess"
],
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": [
"null",
"string"
]
},
"sections": {
"type": "array",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"hasAccessToAllLanguages": {
"type": "boolean"
},
"documentStartNode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"documentRootAccess": {
"type": "boolean"
},
"mediaStartNode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"mediaRootAccess": {
"type": "boolean"
},
"elementStartNode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"elementRootAccess": {
"type": "boolean"
},
"fallbackPermissions": {
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPermissionPresentationModel"
}
}
}
},
"CreateUserRequestModel": {
"required": [
"kind",
"email",
"userName",
"name",
"userGroupIds"
],
"type": "object",
"properties": {
"kind": {
"$ref": "#/components/schemas/UserKindModel"
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"email": {
"type": "string"
},
"userName": {
"type": "string"
},
"name": {
"type": "string"
},
"userGroupIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"CreateWebhookRequestModel": {
"required": [
"url",
"events",
"enabled",
"contentTypeKeys",
"headers"
],
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"enabled": {
"type": "boolean"
},
"name": {
"type": [
"null",
"string"
]
},
"description": {
"type": [
"null",
"string"
]
},
"url": {
"type": "string"
},
"contentTypeKeys": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"CultureAndScheduleRequestModel": {
"type": "object",
"properties": {
"culture": {
"type": [
"null",
"string"
]
},
"schedule": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ScheduleRequestModel"
}
]
}
}
},
"CultureReponseModel": {
"required": [
"name",
"englishName"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"englishName": {
"type": "string"
}
}
},
"CurrentUserConfigurationResponseModel": {
"required": [
"passwordConfiguration",
"keepUserLoggedIn",
"allowChangePassword",
"allowTwoFactor"
],
"type": "object",
"properties": {
"keepUserLoggedIn": {
"type": "boolean"
},
"passwordConfiguration": {
"$ref": "#/components/schemas/PasswordConfigurationResponseModel"
},
"allowChangePassword": {
"type": "boolean"
},
"allowTwoFactor": {
"type": "boolean"
}
}
},
"CurrentUserResponseModel": {
"required": [
"id",
"languageIsoCode",
"documentStartNodeIds",
"hasDocumentRootAccess",
"mediaStartNodeIds",
"hasMediaRootAccess",
"elementStartNodeIds",
"hasElementRootAccess",
"avatarUrls",
"languages",
"hasAccessToAllLanguages",
"hasAccessToSensitiveData",
"fallbackPermissions",
"permissions",
"allowedSections",
"isAdmin",
"email",
"userName",
"name",
"userGroupIds"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"languageIsoCode": {
"type": [
"null",
"string"
]
},
"documentStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasDocumentRootAccess": {
"type": "boolean"
},
"mediaStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasMediaRootAccess": {
"type": "boolean"
},
"elementStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasElementRootAccess": {
"type": "boolean"
},
"avatarUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"hasAccessToAllLanguages": {
"type": "boolean"
},
"hasAccessToSensitiveData": {
"type": "boolean"
},
"fallbackPermissions": {
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPermissionPresentationModel"
}
},
"allowedSections": {
"type": "array",
"items": {
"type": "string"
}
},
"isAdmin": {
"type": "boolean"
},
"email": {
"type": "string"
},
"userName": {
"type": "string"
},
"name": {
"type": "string"
},
"userGroupIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"DatabaseInstallRequestModel": {
"required": [
"id",
"providerName",
"useIntegratedAuthentication",
"trustServerCertificate"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"providerName": {
"type": [
"null",
"string"
]
},
"server": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
},
"username": {
"type": [
"null",
"string"
]
},
"password": {
"type": [
"null",
"string"
]
},
"useIntegratedAuthentication": {
"type": "boolean"
},
"connectionString": {
"type": [
"null",
"string"
]
},
"trustServerCertificate": {
"type": "boolean"
}
}
},
"DatabaseSettingsPresentationModel": {
"required": [
"displayName",
"defaultDatabaseName",
"providerName",
"serverPlaceholder",
"id",
"sortOrder",
"isConfigured",
"requiresServer",
"requiresCredentials",
"supportsIntegratedAuthentication",
"supportsTrustServerCertificate",
"requiresConnectionTest"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"displayName": {
"type": "string"
},
"defaultDatabaseName": {
"type": "string"
},
"providerName": {
"type": "string"
},
"isConfigured": {
"type": "boolean"
},
"requiresServer": {
"type": "boolean"
},
"serverPlaceholder": {
"type": "string"
},
"requiresCredentials": {
"type": "boolean"
},
"supportsIntegratedAuthentication": {
"type": "boolean"
},
"supportsTrustServerCertificate": {
"type": "boolean"
},
"requiresConnectionTest": {
"type": "boolean"
}
}
},
"DataTypeChangeModeModel": {
"enum": [
"True",
"False",
"FalseWithHelpText"
]
},
"DatatypeConfigurationResponseModel": {
"required": [
"canBeChanged",
"documentListViewId",
"mediaListViewId"
],
"type": "object",
"properties": {
"canBeChanged": {
"$ref": "#/components/schemas/DataTypeChangeModeModel"
},
"documentListViewId": {
"type": "string",
"format": "uuid"
},
"mediaListViewId": {
"type": "string",
"format": "uuid"
}
}
},
"DataTypeItemResponseModel": {
"required": [
"editorAlias",
"isDeletable",
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"editorUiAlias": {
"type": [
"null",
"string"
]
},
"editorAlias": {
"type": "string"
},
"isDeletable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"DataTypePropertyPresentationModel": {
"required": [
"alias"
],
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"value": {}
}
},
"DataTypeResponseModel": {
"required": [
"name",
"editorAlias",
"id",
"isDeletable",
"canIgnoreStartNodes",
"editorUiAlias",
"values"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"isDeletable": {
"type": "boolean"
},
"canIgnoreStartNodes": {
"type": "boolean"
},
"name": {
"type": "string"
},
"editorAlias": {
"type": "string"
},
"editorUiAlias": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypePropertyPresentationModel"
}
}
}
},
"DataTypeSchemaItemResponseModel": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"valueTypeName": {
"type": [
"null",
"string"
]
},
"jsonSchema": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/JsonObject"
}
]
},
"error": {
"type": [
"null",
"string"
]
}
}
},
"DataTypeSchemaResponseModel": {
"type": "object",
"properties": {
"valueTypeName": {
"type": [
"null",
"string"
]
},
"jsonSchema": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/JsonObject"
}
]
}
}
},
"DataTypeTreeItemResponseModel": {
"required": [
"isDeletable",
"isFolder",
"noAccess",
"name",
"id",
"flags",
"hasChildren"
],
"type": "object",
"properties": {
"editorUiAlias": {
"type": [
"null",
"string"
]
},
"isDeletable": {
"type": "boolean"
},
"isFolder": {
"type": "boolean"
},
"noAccess": {
"type": "boolean"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"hasChildren": {
"type": "boolean"
}
}
},
"DeleteUserGroupsRequestModel": {
"required": [
"userGroupIds"
],
"type": "object",
"properties": {
"userGroupIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"DeleteUsersRequestModel": {
"required": [
"userIds"
],
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"DictionaryItemItemResponseModel": {
"required": [
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"DictionaryItemResponseModel": {
"required": [
"name",
"id",
"translations"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryItemTranslationModel"
}
}
}
},
"DictionaryItemTranslationModel": {
"required": [
"isoCode",
"translation"
],
"type": "object",
"properties": {
"isoCode": {
"type": "string"
},
"translation": {
"type": "string"
}
}
},
"DictionaryOverviewResponseModel": {
"required": [
"id",
"translatedIsoCodes"
],
"type": "object",
"properties": {
"name": {
"type": [
"null",
"string"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"translatedIsoCodes": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"DirectionModel": {
"enum": [
"Ascending",
"Descending"
]
},
"DisableUserRequestModel": {
"required": [
"userIds"
],
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"DocumentBlueprintItemResponseModel": {
"required": [
"documentType",
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"DocumentBlueprintResponseModel": {
"required": [
"documentType",
"id",
"flags",
"values",
"variants"
],
"type": "object",
"properties": {
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueResponseModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantResponseModel"
}
}
}
},
"DocumentBlueprintTreeItemResponseModel": {
"required": [
"isFolder",
"noAccess",
"name",
"id",
"flags",
"hasChildren"
],
"type": "object",
"properties": {
"documentType": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
}
]
},
"isFolder": {
"type": "boolean"
},
"noAccess": {
"type": "boolean"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"hasChildren": {
"type": "boolean"
}
}
},
"DocumentCollectionResponseModel": {
"required": [
"documentType",
"isTrashed",
"isProtected",
"ancestors",
"sortOrder",
"id",
"flags",
"values",
"variants"
],
"type": "object",
"properties": {
"documentType": {
"$ref": "#/components/schemas/DocumentTypeCollectionReferenceResponseModel"
},
"isTrashed": {
"type": "boolean"
},
"isProtected": {
"type": "boolean"
},
"ancestors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"updater": {
"type": [
"null",
"string"
]
},
"creator": {
"type": [
"null",
"string"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueResponseModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantResponseModel"
}
}
}
},
"DocumentConfigurationResponseModel": {
"required": [
"disableDeleteWhenReferenced",
"disableUnpublishWhenReferenced",
"allowEditInvariantFromNonDefault",
"allowNonExistingSegmentsCreation"
],
"type": "object",
"properties": {
"disableDeleteWhenReferenced": {
"type": "boolean"
},
"disableUnpublishWhenReferenced": {
"type": "boolean"
},
"allowEditInvariantFromNonDefault": {
"type": "boolean"
},
"allowNonExistingSegmentsCreation": {
"type": "boolean"
}
}
},
"DocumentItemResponseModel": {
"required": [
"isTrashed",
"isProtected",
"hasChildren",
"documentType",
"variants",
"id",
"flags"
],
"type": "object",
"properties": {
"isTrashed": {
"type": "boolean"
},
"isProtected": {
"type": "boolean"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"hasChildren": {
"type": "boolean"
},
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantItemResponseModel"
}
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"DocumentNotificationResponseModel": {
"required": [
"actionId",
"alias",
"subscribed"
],
"type": "object",
"properties": {
"actionId": {
"type": "string"
},
"alias": {
"type": "string"
},
"subscribed": {
"type": "boolean"
}
}
},
"DocumentRecycleBinItemResponseModel": {
"required": [
"id",
"hasChildren",
"documentType",
"variants",
"createDate"
],
"type": "object",
"properties": {
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantItemResponseModel"
}
},
"id": {
"type": "string",
"format": "uuid"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"hasChildren": {
"type": "boolean"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ItemReferenceByIdResponseModel"
}
]
}
}
},
"DocumentResponseModel": {
"required": [
"isTrashed",
"documentType",
"id",
"flags",
"values",
"variants"
],
"type": "object",
"properties": {
"template": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"isTrashed": {
"type": "boolean"
},
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueResponseModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantResponseModel"
}
}
}
},
"DocumentTreeItemResponseModel": {
"required": [
"isProtected",
"ancestors",
"documentType",
"variants",
"noAccess",
"isTrashed",
"createDate",
"id",
"flags",
"hasChildren"
],
"type": "object",
"properties": {
"isProtected": {
"type": "boolean"
},
"ancestors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantItemResponseModel"
}
},
"noAccess": {
"type": "boolean"
},
"isTrashed": {
"type": "boolean"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"hasChildren": {
"type": "boolean"
}
}
},
"DocumentTypeAllowedParentsResponseModel": {
"required": [
"allowedParentIds"
],
"type": "object",
"properties": {
"allowedParentIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"DocumentTypeBlueprintItemResponseModel": {
"required": [
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"DocumentTypeCleanupModel": {
"required": [
"preventCleanup"
],
"type": "object",
"properties": {
"preventCleanup": {
"type": "boolean"
},
"keepAllVersionsNewerThanDays": {
"type": [
"null",
"integer"
],
"format": "int32"
},
"keepLatestVersionPerDayForDays": {
"type": [
"null",
"integer"
],
"format": "int32"
}
}
},
"DocumentTypeCollectionReferenceResponseModel": {
"required": [
"id",
"alias",
"icon"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"alias": {
"type": "string"
},
"icon": {
"type": "string"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"DocumentTypeCompositionModel": {
"required": [
"documentType",
"compositionType"
],
"type": "object",
"properties": {
"documentType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"compositionType": {
"$ref": "#/components/schemas/CompositionTypeModel"
}
}
},
"DocumentTypeCompositionRequestModel": {
"required": [
"isElement",
"currentPropertyAliases",
"currentCompositeIds"
],
"type": "object",
"properties": {
"isElement": {
"type": "boolean"
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"currentPropertyAliases": {
"type": "array",
"items": {
"type": "string"
}
},
"currentCompositeIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"DocumentTypeCompositionResponseModel": {
"required": [
"id",
"name",
"icon"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
}
}
},
"DocumentTypeConfigurationResponseModel": {
"required": [
"dataTypesCanBeChanged",
"disableTemplates",
"useSegments",
"reservedFieldNames"
],
"type": "object",
"properties": {
"dataTypesCanBeChanged": {
"$ref": "#/components/schemas/DataTypeChangeModeModel"
},
"disableTemplates": {
"type": "boolean"
},
"useSegments": {
"type": "boolean"
},
"reservedFieldNames": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"DocumentTypeItemResponseModel": {
"required": [
"isElement",
"allowedInLibrary",
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"isElement": {
"type": "boolean"
},
"allowedInLibrary": {
"type": "boolean"
},
"icon": {
"type": [
"null",
"string"
]
},
"description": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"DocumentTypePropertyTypeContainerResponseModel": {
"required": [
"type",
"id",
"sortOrder"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": [
"null",
"string"
]
},
"type": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"DocumentTypePropertyTypeResponseModel": {
"required": [
"alias",
"name",
"id",
"sortOrder",
"dataType",
"variesByCulture",
"variesBySegment",
"validation",
"appearance"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"container": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"dataType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"validation": {
"$ref": "#/components/schemas/PropertyTypeValidationModel"
},
"appearance": {
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
}
}
},
"DocumentTypeReferenceResponseModel": {
"required": [
"id",
"icon"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"icon": {
"type": "string"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"DocumentTypeResponseModel": {
"required": [
"alias",
"name",
"icon",
"properties",
"allowedTemplates",
"cleanup",
"allowedDocumentTypes",
"compositions",
"id",
"allowedAsRoot",
"variesByCulture",
"variesBySegment",
"isElement",
"allowedInLibrary",
"containers"
],
"type": "object",
"properties": {
"allowedTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"defaultTemplate": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"cleanup": {
"$ref": "#/components/schemas/DocumentTypeCleanupModel"
},
"allowedDocumentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeSortModel"
}
},
"compositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeCompositionModel"
}
},
"id": {
"type": "string",
"format": "uuid"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"isElement": {
"type": "boolean"
},
"allowedInLibrary": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypePropertyTypeResponseModel"
}
},
"containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypePropertyTypeContainerResponseModel"
}
}
}
},
"DocumentTypeSortModel": {
"required": [
"documentType",
"sortOrder"
],
"type": "object",
"properties": {
"documentType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"DocumentTypeTreeItemResponseModel": {
"required": [
"isElement",
"icon",
"isFolder",
"noAccess",
"name",
"id",
"flags",
"hasChildren"
],
"type": "object",
"properties": {
"isElement": {
"type": "boolean"
},
"icon": {
"type": "string"
},
"isFolder": {
"type": "boolean"
},
"noAccess": {
"type": "boolean"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"hasChildren": {
"type": "boolean"
}
}
},
"DocumentUrlInfoModel": {
"required": [
"message",
"provider",
"culture",
"url",
"isExternal"
],
"type": "object",
"properties": {
"message": {
"type": [
"null",
"string"
]
},
"provider": {
"type": "string"
},
"isExternal": {
"type": "boolean"
},
"culture": {
"type": [
"null",
"string"
]
},
"url": {
"type": [
"null",
"string"
]
}
}
},
"DocumentUrlInfoResponseModel": {
"required": [
"id",
"urlInfos"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"urlInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentUrlInfoModel"
}
}
}
},
"DocumentValueModel": {
"required": [
"alias"
],
"type": "object",
"properties": {
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"alias": {
"type": "string"
},
"value": {}
}
},
"DocumentValueResponseModel": {
"required": [
"editorAlias",
"alias"
],
"type": "object",
"properties": {
"editorAlias": {
"type": "string"
},
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"alias": {
"type": "string"
},
"value": {}
}
},
"DocumentVariantItemResponseModel": {
"required": [
"state",
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"state": {
"$ref": "#/components/schemas/PublishableVariantStateModel"
},
"name": {
"type": "string"
},
"culture": {
"type": [
"null",
"string"
]
}
}
},
"DocumentVariantRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
}
}
},
"DocumentVariantResponseModel": {
"required": [
"name",
"id",
"flags",
"state",
"createDate",
"updateDate"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"state": {
"$ref": "#/components/schemas/PublishableVariantStateModel"
},
"publishDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"scheduledPublishDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"scheduledUnpublishDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updateDate": {
"type": "string",
"format": "date-time"
},
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
}
}
},
"DocumentVersionItemResponseModel": {
"required": [
"id",
"document",
"documentType",
"user",
"versionDate",
"isCurrentPublishedVersion",
"isCurrentDraftVersion",
"preventCleanup"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"document": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"documentType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"user": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"versionDate": {
"type": "string",
"format": "date-time"
},
"isCurrentPublishedVersion": {
"type": "boolean"
},
"isCurrentDraftVersion": {
"type": "boolean"
},
"preventCleanup": {
"type": "boolean"
}
}
},
"DocumentVersionResponseModel": {
"required": [
"documentType",
"id",
"flags",
"values",
"variants"
],
"type": "object",
"properties": {
"document": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueResponseModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantResponseModel"
}
}
}
},
"DomainPresentationModel": {
"required": [
"domainName",
"isoCode"
],
"type": "object",
"properties": {
"domainName": {
"type": "string"
},
"isoCode": {
"type": "string"
}
}
},
"DomainsResponseModel": {
"required": [
"domains"
],
"type": "object",
"properties": {
"defaultIsoCode": {
"type": [
"null",
"string"
]
},
"domains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DomainPresentationModel"
}
}
}
},
"DynamicRootContextRequestModel": {
"required": [
"parent"
],
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"parent": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
}
}
},
"DynamicRootQueryOriginRequestModel": {
"required": [
"alias"
],
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
}
}
},
"DynamicRootQueryRequestModel": {
"required": [
"origin",
"steps"
],
"type": "object",
"properties": {
"origin": {
"$ref": "#/components/schemas/DynamicRootQueryOriginRequestModel"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicRootQueryStepRequestModel"
}
}
}
},
"DynamicRootQueryStepRequestModel": {
"required": [
"alias",
"documentTypeIds"
],
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"documentTypeIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"DynamicRootRequestModel": {
"required": [
"context",
"query"
],
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/DynamicRootContextRequestModel"
},
"query": {
"$ref": "#/components/schemas/DynamicRootQueryRequestModel"
}
}
},
"DynamicRootResponseModel": {
"required": [
"roots"
],
"type": "object",
"properties": {
"roots": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"ElementConfigurationResponseModel": {
"required": [
"disableDeleteWhenReferenced",
"disableUnpublishWhenReferenced",
"allowEditInvariantFromNonDefault",
"allowNonExistingSegmentsCreation"
],
"type": "object",
"properties": {
"disableDeleteWhenReferenced": {
"type": "boolean"
},
"disableUnpublishWhenReferenced": {
"type": "boolean"
},
"allowEditInvariantFromNonDefault": {
"type": "boolean"
},
"allowNonExistingSegmentsCreation": {
"type": "boolean"
}
}
},
"ElementItemResponseModel": {
"required": [
"isTrashed",
"hasChildren",
"documentType",
"variants",
"id",
"flags"
],
"type": "object",
"properties": {
"isTrashed": {
"type": "boolean"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"hasChildren": {
"type": "boolean"
},
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantItemResponseModel"
}
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"ElementRecycleBinItemResponseModel": {
"required": [
"id",
"hasChildren",
"variants",
"isFolder",
"name",
"createDate"
],
"type": "object",
"properties": {
"documentType": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
}
]
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantItemResponseModel"
}
},
"isFolder": {
"type": "boolean"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"hasChildren": {
"type": "boolean"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ItemReferenceByIdResponseModel"
}
]
}
}
},
"ElementResponseModel": {
"required": [
"isTrashed",
"documentType",
"id",
"flags",
"values",
"variants"
],
"type": "object",
"properties": {
"isTrashed": {
"type": "boolean"
},
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementValueResponseModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantResponseModel"
}
}
}
},
"ElementTreeItemResponseModel": {
"required": [
"createDate",
"variants",
"isFolder",
"noAccess",
"name",
"id",
"flags",
"hasChildren"
],
"type": "object",
"properties": {
"createDate": {
"type": "string",
"format": "date-time"
},
"documentType": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
}
]
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantItemResponseModel"
}
},
"isFolder": {
"type": "boolean"
},
"noAccess": {
"type": "boolean"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"hasChildren": {
"type": "boolean"
}
}
},
"ElementValueModel": {
"required": [
"alias"
],
"type": "object",
"properties": {
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"alias": {
"type": "string"
},
"value": {}
}
},
"ElementValueResponseModel": {
"required": [
"editorAlias",
"alias"
],
"type": "object",
"properties": {
"editorAlias": {
"type": "string"
},
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"alias": {
"type": "string"
},
"value": {}
}
},
"ElementVariantItemResponseModel": {
"required": [
"state",
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"state": {
"$ref": "#/components/schemas/PublishableVariantStateModel"
},
"name": {
"type": "string"
},
"culture": {
"type": [
"null",
"string"
]
}
}
},
"ElementVariantRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
}
}
},
"ElementVariantResponseModel": {
"required": [
"name",
"id",
"flags",
"state",
"createDate",
"updateDate"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"state": {
"$ref": "#/components/schemas/PublishableVariantStateModel"
},
"publishDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"scheduledPublishDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"scheduledUnpublishDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updateDate": {
"type": "string",
"format": "date-time"
},
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
}
}
},
"ElementVersionItemResponseModel": {
"required": [
"id",
"element",
"documentType",
"user",
"versionDate",
"isCurrentPublishedVersion",
"isCurrentDraftVersion",
"preventCleanup"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"element": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"documentType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"user": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"versionDate": {
"type": "string",
"format": "date-time"
},
"isCurrentPublishedVersion": {
"type": "boolean"
},
"isCurrentDraftVersion": {
"type": "boolean"
},
"preventCleanup": {
"type": "boolean"
}
}
},
"ElementVersionResponseModel": {
"required": [
"documentType",
"id",
"flags",
"values",
"variants"
],
"type": "object",
"properties": {
"element": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementValueResponseModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantResponseModel"
}
}
}
},
"EnableTwoFactorRequestModel": {
"required": [
"code",
"secret"
],
"type": "object",
"properties": {
"code": {
"type": "string"
},
"secret": {
"type": "string"
}
}
},
"EnableUserRequestModel": {
"required": [
"userIds"
],
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"EntityImportAnalysisResponseModel": {
"required": [
"entityType"
],
"type": "object",
"properties": {
"entityType": {
"type": "string"
},
"alias": {
"type": [
"null",
"string"
]
},
"key": {
"type": [
"null",
"string"
],
"format": "uuid"
}
}
},
"EventMessageTypeModel": {
"enum": [
"Default",
"Info",
"Error",
"Success",
"Warning"
]
},
"FetchResponseModelDataTypeSchemaItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypeSchemaItemResponseModel"
}
}
}
},
"FieldPresentationModel": {
"required": [
"name",
"values"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FileSystemFolderModel": {
"required": [
"path"
],
"type": "object",
"properties": {
"path": {
"type": "string"
}
}
},
"FileSystemTreeItemPresentationModel": {
"required": [
"name",
"path",
"isFolder",
"hasChildren"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
},
"isFolder": {
"type": "boolean"
},
"hasChildren": {
"type": "boolean"
}
}
},
"FlagModel": {
"required": [
"alias"
],
"type": "object",
"properties": {
"alias": {
"type": "string"
}
}
},
"FolderItemResponseModel": {
"required": [
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"FolderResponseModel": {
"required": [
"name",
"id",
"isTrashed"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"isTrashed": {
"type": "boolean"
},
"name": {
"type": "string"
}
}
},
"HealthCheckActionRequestModel": {
"required": [
"healthCheck",
"valueRequired"
],
"type": "object",
"properties": {
"healthCheck": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"alias": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
},
"description": {
"type": [
"null",
"string"
]
},
"valueRequired": {
"type": "boolean"
},
"providedValue": {
"type": [
"null",
"string"
]
},
"providedValueValidation": {
"type": [
"null",
"string"
]
},
"providedValueValidationRegex": {
"type": [
"null",
"string"
]
},
"actionParameters": {
"type": [
"null",
"object"
]
}
}
},
"HealthCheckGroupPresentationModel": {
"required": [
"checks",
"name"
],
"type": "object",
"properties": {
"checks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthCheckModel"
}
},
"name": {
"type": "string"
}
}
},
"HealthCheckGroupResponseModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"HealthCheckGroupWithResultResponseModel": {
"required": [
"checks"
],
"type": "object",
"properties": {
"checks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthCheckWithResultPresentationModel"
}
}
}
},
"HealthCheckModel": {
"required": [
"name",
"id"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"id": {
"type": "string",
"format": "uuid"
}
}
},
"HealthCheckResultResponseModel": {
"required": [
"message",
"resultType"
],
"type": "object",
"properties": {
"message": {
"type": "string"
},
"resultType": {
"$ref": "#/components/schemas/StatusResultTypeModel"
},
"actions": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/HealthCheckActionRequestModel"
}
},
"readMoreLink": {
"type": [
"null",
"string"
]
}
}
},
"HealthCheckWithResultPresentationModel": {
"required": [
"id"
],
"type": "object",
"properties": {
"results": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/HealthCheckResultResponseModel"
}
},
"id": {
"type": "string",
"format": "uuid"
}
}
},
"HealthStatusModel": {
"enum": [
"Healthy",
"Unhealthy",
"Rebuilding",
"Corrupt"
]
},
"HealthStatusResponseModel": {
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/HealthStatusModel"
},
"message": {
"type": [
"null",
"string"
]
}
}
},
"HelpPageResponseModel": {
"type": "object",
"properties": {
"name": {
"type": [
"null",
"string"
]
},
"description": {
"type": [
"null",
"string"
]
},
"url": {
"type": [
"null",
"string"
]
},
"type": {
"type": [
"null",
"string"
]
}
}
},
"ImageCropModeModel": {
"enum": [
"Crop",
"Max",
"Stretch",
"Pad",
"BoxPad",
"Min",
null
]
},
"ImportDictionaryRequestModel": {
"required": [
"temporaryFile"
],
"type": "object",
"properties": {
"temporaryFile": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"ImportDocumentTypeRequestModel": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
},
"ImportMediaTypeRequestModel": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
},
"ImportMemberTypeRequestModel": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
},
"IndexResponseModel": {
"required": [
"name",
"canRebuild",
"documentCount",
"fieldCount",
"healthStatus",
"searcherName"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"healthStatus": {
"$ref": "#/components/schemas/HealthStatusResponseModel"
},
"canRebuild": {
"type": "boolean"
},
"searcherName": {
"type": "string"
},
"documentCount": {
"type": "integer",
"format": "int64"
},
"fieldCount": {
"type": "integer",
"format": "int32"
},
"providerProperties": {
"type": [
"null",
"object"
]
},
"uniqueKeyFieldName": {
"type": [
"null",
"string"
]
}
}
},
"InstallRequestModel": {
"required": [
"user",
"database",
"telemetryLevel"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserInstallRequestModel"
},
"database": {
"$ref": "#/components/schemas/DatabaseInstallRequestModel"
},
"telemetryLevel": {
"$ref": "#/components/schemas/TelemetryLevelModel"
}
}
},
"InstallSettingsResponseModel": {
"required": [
"user",
"databases"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserSettingsPresentationModel"
},
"databases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatabaseSettingsPresentationModel"
}
}
}
},
"InviteUserRequestModel": {
"required": [
"email",
"userName",
"name",
"userGroupIds"
],
"type": "object",
"properties": {
"message": {
"type": [
"null",
"string"
]
},
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"email": {
"type": "string"
},
"userName": {
"type": "string"
},
"name": {
"type": "string"
},
"userGroupIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"IPermissionPresentationModel": {
"required": [
"$type"
],
"type": "object",
"anyOf": [
{
"$ref": "#/components/schemas/IPermissionPresentationModelDocumentPermissionPresentationModel"
},
{
"$ref": "#/components/schemas/IPermissionPresentationModelDocumentPropertyValuePermissionPresentationModel"
},
{
"$ref": "#/components/schemas/IPermissionPresentationModelElementPermissionPresentationModel"
},
{
"$ref": "#/components/schemas/IPermissionPresentationModelUnknownTypePermissionPresentationModel"
}
],
"discriminator": {
"propertyName": "$type",
"mapping": {
"DocumentPermissionPresentationModel": "#/components/schemas/IPermissionPresentationModelDocumentPermissionPresentationModel",
"DocumentPropertyValuePermissionPresentationModel": "#/components/schemas/IPermissionPresentationModelDocumentPropertyValuePermissionPresentationModel",
"ElementPermissionPresentationModel": "#/components/schemas/IPermissionPresentationModelElementPermissionPresentationModel",
"UnknownTypePermissionPresentationModel": "#/components/schemas/IPermissionPresentationModelUnknownTypePermissionPresentationModel"
}
}
},
"IPermissionPresentationModelDocumentPermissionPresentationModel": {
"required": [
"document",
"verbs",
"$type"
],
"properties": {
"$type": {
"enum": [
"DocumentPermissionPresentationModel"
],
"type": "string"
},
"document": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"verbs": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"IPermissionPresentationModelDocumentPropertyValuePermissionPresentationModel": {
"required": [
"documentType",
"propertyType",
"verbs",
"$type"
],
"properties": {
"$type": {
"enum": [
"DocumentPropertyValuePermissionPresentationModel"
],
"type": "string"
},
"documentType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"propertyType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"verbs": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"IPermissionPresentationModelElementPermissionPresentationModel": {
"required": [
"element",
"verbs",
"$type"
],
"properties": {
"$type": {
"enum": [
"ElementPermissionPresentationModel"
],
"type": "string"
},
"element": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"verbs": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"IPermissionPresentationModelUnknownTypePermissionPresentationModel": {
"required": [
"verbs",
"context",
"$type"
],
"properties": {
"$type": {
"enum": [
"UnknownTypePermissionPresentationModel"
],
"type": "string"
},
"verbs": {
"type": "array",
"items": {
"type": "string"
}
},
"context": {
"type": "string"
}
}
},
"IReferenceResponseModel": {
"required": [
"$type"
],
"type": "object",
"anyOf": [
{
"$ref": "#/components/schemas/IReferenceResponseModelDefaultReferenceResponseModel"
},
{
"$ref": "#/components/schemas/IReferenceResponseModelDocumentReferenceResponseModel"
},
{
"$ref": "#/components/schemas/IReferenceResponseModelDocumentTypePropertyTypeReferenceResponseModel"
},
{
"$ref": "#/components/schemas/IReferenceResponseModelElementContainerReferenceResponseModel"
},
{
"$ref": "#/components/schemas/IReferenceResponseModelElementReferenceResponseModel"
},
{
"$ref": "#/components/schemas/IReferenceResponseModelMediaReferenceResponseModel"
},
{
"$ref": "#/components/schemas/IReferenceResponseModelMediaTypePropertyTypeReferenceResponseModel"
},
{
"$ref": "#/components/schemas/IReferenceResponseModelMemberReferenceResponseModel"
},
{
"$ref": "#/components/schemas/IReferenceResponseModelMemberTypePropertyTypeReferenceResponseModel"
}
],
"discriminator": {
"propertyName": "$type",
"mapping": {
"DefaultReferenceResponseModel": "#/components/schemas/IReferenceResponseModelDefaultReferenceResponseModel",
"DocumentReferenceResponseModel": "#/components/schemas/IReferenceResponseModelDocumentReferenceResponseModel",
"DocumentTypePropertyTypeReferenceResponseModel": "#/components/schemas/IReferenceResponseModelDocumentTypePropertyTypeReferenceResponseModel",
"ElementContainerReferenceResponseModel": "#/components/schemas/IReferenceResponseModelElementContainerReferenceResponseModel",
"ElementReferenceResponseModel": "#/components/schemas/IReferenceResponseModelElementReferenceResponseModel",
"MediaReferenceResponseModel": "#/components/schemas/IReferenceResponseModelMediaReferenceResponseModel",
"MediaTypePropertyTypeReferenceResponseModel": "#/components/schemas/IReferenceResponseModelMediaTypePropertyTypeReferenceResponseModel",
"MemberReferenceResponseModel": "#/components/schemas/IReferenceResponseModelMemberReferenceResponseModel",
"MemberTypePropertyTypeReferenceResponseModel": "#/components/schemas/IReferenceResponseModelMemberTypePropertyTypeReferenceResponseModel"
}
}
},
"IReferenceResponseModelDefaultReferenceResponseModel": {
"required": [
"$type",
"id"
],
"properties": {
"$type": {
"enum": [
"DefaultReferenceResponseModel"
],
"type": "string"
},
"type": {
"type": [
"null",
"string"
]
},
"icon": {
"type": [
"null",
"string"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"IReferenceResponseModelDocumentReferenceResponseModel": {
"required": [
"$type",
"documentType",
"variants",
"id"
],
"properties": {
"$type": {
"enum": [
"DocumentReferenceResponseModel"
],
"type": "string"
},
"published": {
"type": [
"null",
"boolean"
]
},
"documentType": {
"$ref": "#/components/schemas/TrackedReferenceDocumentTypeModel"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantItemResponseModel"
}
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"IReferenceResponseModelDocumentTypePropertyTypeReferenceResponseModel": {
"required": [
"$type",
"documentType",
"id"
],
"properties": {
"$type": {
"enum": [
"DocumentTypePropertyTypeReferenceResponseModel"
],
"type": "string"
},
"documentType": {
"$ref": "#/components/schemas/TrackedReferenceDocumentTypeModel"
},
"alias": {
"type": [
"null",
"string"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"IReferenceResponseModelElementContainerReferenceResponseModel": {
"required": [
"$type",
"id"
],
"properties": {
"$type": {
"enum": [
"ElementContainerReferenceResponseModel"
],
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"IReferenceResponseModelElementReferenceResponseModel": {
"required": [
"$type",
"documentType",
"variants",
"id"
],
"properties": {
"$type": {
"enum": [
"ElementReferenceResponseModel"
],
"type": "string"
},
"published": {
"type": [
"null",
"boolean"
]
},
"documentType": {
"$ref": "#/components/schemas/TrackedReferenceDocumentTypeModel"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantItemResponseModel"
}
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"IReferenceResponseModelMediaReferenceResponseModel": {
"required": [
"$type",
"mediaType",
"id"
],
"properties": {
"$type": {
"enum": [
"MediaReferenceResponseModel"
],
"type": "string"
},
"mediaType": {
"$ref": "#/components/schemas/TrackedReferenceMediaTypeModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"IReferenceResponseModelMediaTypePropertyTypeReferenceResponseModel": {
"required": [
"$type",
"mediaType",
"id"
],
"properties": {
"$type": {
"enum": [
"MediaTypePropertyTypeReferenceResponseModel"
],
"type": "string"
},
"mediaType": {
"$ref": "#/components/schemas/TrackedReferenceMediaTypeModel"
},
"alias": {
"type": [
"null",
"string"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"IReferenceResponseModelMemberReferenceResponseModel": {
"required": [
"$type",
"memberType",
"id"
],
"properties": {
"$type": {
"enum": [
"MemberReferenceResponseModel"
],
"type": "string"
},
"memberType": {
"$ref": "#/components/schemas/TrackedReferenceMemberTypeModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"IReferenceResponseModelMemberTypePropertyTypeReferenceResponseModel": {
"required": [
"$type",
"memberType",
"id"
],
"properties": {
"$type": {
"enum": [
"MemberTypePropertyTypeReferenceResponseModel"
],
"type": "string"
},
"memberType": {
"$ref": "#/components/schemas/TrackedReferenceMemberTypeModel"
},
"alias": {
"type": [
"null",
"string"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"ISetupTwoFactorModel": {
"required": [
"$type"
],
"type": "object",
"anyOf": [
{
"$ref": "#/components/schemas/ISetupTwoFactorModelNoopSetupTwoFactorModel"
}
],
"discriminator": {
"propertyName": "$type",
"mapping": {
"NoopSetupTwoFactorModel": "#/components/schemas/ISetupTwoFactorModelNoopSetupTwoFactorModel"
}
}
},
"ISetupTwoFactorModelNoopSetupTwoFactorModel": {
"required": [
"$type"
],
"properties": {
"$type": {
"enum": [
"NoopSetupTwoFactorModel"
],
"type": "string"
}
}
},
"ItemAncestorsResponseModelDocumentItemResponseModel": {
"required": [
"id",
"ancestors"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"ancestors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentItemResponseModel"
}
}
}
},
"ItemAncestorsResponseModelMediaItemResponseModel": {
"required": [
"id",
"ancestors"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"ancestors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaItemResponseModel"
}
}
}
},
"ItemAncestorsResponseModelMemberItemResponseModel": {
"required": [
"id",
"ancestors"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"ancestors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberItemResponseModel"
}
}
}
},
"ItemAncestorsResponseModelNamedItemResponseModel": {
"required": [
"id",
"ancestors"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"ancestors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NamedItemResponseModel"
}
}
}
},
"ItemAncestorsResponseModelTemplateItemResponseModel": {
"required": [
"id",
"ancestors"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"ancestors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateItemResponseModel"
}
}
}
},
"ItemReferenceByIdResponseModel": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
}
},
"ItemSortingRequestModel": {
"required": [
"id",
"sortOrder"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"JsonObject": {
"type": "object"
},
"LanguageItemResponseModel": {
"required": [
"name",
"isoCode"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"isoCode": {
"type": "string"
}
}
},
"LanguageResponseModel": {
"required": [
"isoCode",
"name",
"isDefault",
"isMandatory"
],
"type": "object",
"properties": {
"isoCode": {
"type": "string"
},
"name": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"isMandatory": {
"type": "boolean"
},
"fallbackIsoCode": {
"type": [
"null",
"string"
]
}
}
},
"LoggerResponseModel": {
"required": [
"name",
"level"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"level": {
"$ref": "#/components/schemas/LogLevelModel"
}
}
},
"LogLevelCountsReponseModel": {
"required": [
"information",
"debug",
"warning",
"error",
"fatal"
],
"type": "object",
"properties": {
"information": {
"type": "integer",
"format": "int32"
},
"debug": {
"type": "integer",
"format": "int32"
},
"warning": {
"type": "integer",
"format": "int32"
},
"error": {
"type": "integer",
"format": "int32"
},
"fatal": {
"type": "integer",
"format": "int32"
}
}
},
"LogLevelModel": {
"enum": [
"Verbose",
"Debug",
"Information",
"Warning",
"Error",
"Fatal"
]
},
"LogMessagePropertyPresentationModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": [
"null",
"string"
]
}
}
},
"LogMessageResponseModel": {
"required": [
"timestamp",
"level",
"properties"
],
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"level": {
"$ref": "#/components/schemas/LogLevelModel"
},
"messageTemplate": {
"type": [
"null",
"string"
]
},
"renderedMessage": {
"type": [
"null",
"string"
]
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogMessagePropertyPresentationModel"
}
},
"exception": {
"type": [
"null",
"string"
]
}
}
},
"LogTemplateResponseModel": {
"required": [
"count"
],
"type": "object",
"properties": {
"messageTemplate": {
"type": [
"null",
"string"
]
},
"count": {
"type": "integer",
"format": "int32"
}
}
},
"ManifestResponseModel": {
"required": [
"name",
"extensions"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": [
"null",
"string"
]
},
"version": {
"type": [
"null",
"string"
]
},
"cacheBuster": {
"type": [
"null",
"string"
]
},
"extensions": {
"type": "array"
}
}
},
"MediaCollectionResponseModel": {
"required": [
"mediaType",
"sortOrder",
"id",
"flags",
"values",
"variants"
],
"type": "object",
"properties": {
"mediaType": {
"$ref": "#/components/schemas/MediaTypeCollectionReferenceResponseModel"
},
"creator": {
"type": [
"null",
"string"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaValueResponseModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaVariantResponseModel"
}
}
}
},
"MediaConfigurationResponseModel": {
"required": [
"disableDeleteWhenReferenced",
"disableUnpublishWhenReferenced"
],
"type": "object",
"properties": {
"disableDeleteWhenReferenced": {
"type": "boolean"
},
"disableUnpublishWhenReferenced": {
"type": "boolean"
}
}
},
"MediaItemResponseModel": {
"required": [
"isTrashed",
"hasChildren",
"mediaType",
"variants",
"id",
"flags"
],
"type": "object",
"properties": {
"isTrashed": {
"type": "boolean"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"hasChildren": {
"type": "boolean"
},
"mediaType": {
"$ref": "#/components/schemas/MediaTypeReferenceResponseModel"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VariantItemResponseModel"
}
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"MediaRecycleBinItemResponseModel": {
"required": [
"id",
"hasChildren",
"mediaType",
"variants",
"createDate"
],
"type": "object",
"properties": {
"mediaType": {
"$ref": "#/components/schemas/MediaTypeReferenceResponseModel"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VariantItemResponseModel"
}
},
"id": {
"type": "string",
"format": "uuid"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"hasChildren": {
"type": "boolean"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ItemReferenceByIdResponseModel"
}
]
}
}
},
"MediaResponseModel": {
"required": [
"isTrashed",
"mediaType",
"id",
"flags",
"values",
"variants"
],
"type": "object",
"properties": {
"isTrashed": {
"type": "boolean"
},
"mediaType": {
"$ref": "#/components/schemas/MediaTypeReferenceResponseModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaValueResponseModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaVariantResponseModel"
}
}
}
},
"MediaTreeItemResponseModel": {
"required": [
"mediaType",
"variants",
"noAccess",
"isTrashed",
"createDate",
"id",
"flags",
"hasChildren"
],
"type": "object",
"properties": {
"mediaType": {
"$ref": "#/components/schemas/MediaTypeReferenceResponseModel"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VariantItemResponseModel"
}
},
"noAccess": {
"type": "boolean"
},
"isTrashed": {
"type": "boolean"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"hasChildren": {
"type": "boolean"
}
}
},
"MediaTypeAllowedParentsResponseModel": {
"required": [
"allowedParentIds"
],
"type": "object",
"properties": {
"allowedParentIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"MediaTypeCollectionReferenceResponseModel": {
"required": [
"id",
"alias",
"icon"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"alias": {
"type": "string"
},
"icon": {
"type": "string"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MediaTypeCompositionModel": {
"required": [
"mediaType",
"compositionType"
],
"type": "object",
"properties": {
"mediaType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"compositionType": {
"$ref": "#/components/schemas/CompositionTypeModel"
}
}
},
"MediaTypeCompositionRequestModel": {
"required": [
"currentPropertyAliases",
"currentCompositeIds"
],
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"currentPropertyAliases": {
"type": "array",
"items": {
"type": "string"
}
},
"currentCompositeIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"MediaTypeCompositionResponseModel": {
"required": [
"id",
"name",
"icon"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
}
}
},
"MediaTypeConfigurationResponseModel": {
"required": [
"reservedFieldNames"
],
"type": "object",
"properties": {
"reservedFieldNames": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MediaTypeItemResponseModel": {
"required": [
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"icon": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"MediaTypePropertyTypeContainerResponseModel": {
"required": [
"type",
"id",
"sortOrder"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": [
"null",
"string"
]
},
"type": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"MediaTypePropertyTypeResponseModel": {
"required": [
"alias",
"name",
"id",
"sortOrder",
"dataType",
"variesByCulture",
"variesBySegment",
"validation",
"appearance"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"container": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"dataType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"validation": {
"$ref": "#/components/schemas/PropertyTypeValidationModel"
},
"appearance": {
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
}
}
},
"MediaTypeReferenceResponseModel": {
"required": [
"id",
"icon"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"icon": {
"type": "string"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MediaTypeResponseModel": {
"required": [
"alias",
"name",
"icon",
"properties",
"allowedMediaTypes",
"compositions",
"isDeletable",
"aliasCanBeChanged",
"id",
"allowedAsRoot",
"variesByCulture",
"variesBySegment",
"isElement",
"allowedInLibrary",
"containers"
],
"type": "object",
"properties": {
"allowedMediaTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeSortModel"
}
},
"compositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeCompositionModel"
}
},
"isDeletable": {
"type": "boolean"
},
"aliasCanBeChanged": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"isElement": {
"type": "boolean"
},
"allowedInLibrary": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypePropertyTypeResponseModel"
}
},
"containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypePropertyTypeContainerResponseModel"
}
}
}
},
"MediaTypeSortModel": {
"required": [
"mediaType",
"sortOrder"
],
"type": "object",
"properties": {
"mediaType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"MediaTypeTreeItemResponseModel": {
"required": [
"icon",
"isDeletable",
"isFolder",
"noAccess",
"name",
"id",
"flags",
"hasChildren"
],
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"isDeletable": {
"type": "boolean"
},
"isFolder": {
"type": "boolean"
},
"noAccess": {
"type": "boolean"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"hasChildren": {
"type": "boolean"
}
}
},
"MediaUrlInfoModel": {
"required": [
"culture",
"url"
],
"type": "object",
"properties": {
"culture": {
"type": [
"null",
"string"
]
},
"url": {
"type": [
"null",
"string"
]
}
}
},
"MediaUrlInfoResponseModel": {
"required": [
"id",
"urlInfos"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"urlInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaUrlInfoModel"
}
}
}
},
"MediaValueModel": {
"required": [
"alias"
],
"type": "object",
"properties": {
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"alias": {
"type": "string"
},
"value": {}
}
},
"MediaValueResponseModel": {
"required": [
"editorAlias",
"alias"
],
"type": "object",
"properties": {
"editorAlias": {
"type": "string"
},
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"alias": {
"type": "string"
},
"value": {}
}
},
"MediaVariantRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
}
}
},
"MediaVariantResponseModel": {
"required": [
"name",
"createDate",
"updateDate"
],
"type": "object",
"properties": {
"createDate": {
"type": "string",
"format": "date-time"
},
"updateDate": {
"type": "string",
"format": "date-time"
},
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
}
}
},
"MemberGroupItemResponseModel": {
"required": [
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"MemberGroupResponseModel": {
"required": [
"name",
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
}
},
"MemberItemResponseModel": {
"required": [
"memberType",
"variants",
"kind",
"id",
"flags"
],
"type": "object",
"properties": {
"memberType": {
"$ref": "#/components/schemas/MemberTypeReferenceResponseModel"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VariantItemResponseModel"
}
},
"kind": {
"$ref": "#/components/schemas/MemberKindModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"MemberKindModel": {
"enum": [
"Default",
"Api",
"ExternalOnly"
]
},
"MemberResponseModel": {
"required": [
"email",
"username",
"memberType",
"isApproved",
"isLockedOut",
"isTwoFactorEnabled",
"failedPasswordAttempts",
"groups",
"kind",
"id",
"flags",
"values",
"variants"
],
"type": "object",
"properties": {
"email": {
"type": "string"
},
"username": {
"type": "string"
},
"memberType": {
"$ref": "#/components/schemas/MemberTypeReferenceResponseModel"
},
"isApproved": {
"type": "boolean"
},
"isLockedOut": {
"type": "boolean"
},
"isTwoFactorEnabled": {
"type": "boolean"
},
"failedPasswordAttempts": {
"type": "integer",
"format": "int32"
},
"lastLoginDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"lastLockoutDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"lastPasswordChangeDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"groups": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"kind": {
"$ref": "#/components/schemas/MemberKindModel"
},
"profileData": {
"type": [
"null",
"string"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberValueResponseModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberVariantResponseModel"
}
}
}
},
"MemberTypeCompositionModel": {
"required": [
"memberType",
"compositionType"
],
"type": "object",
"properties": {
"memberType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"compositionType": {
"$ref": "#/components/schemas/CompositionTypeModel"
}
}
},
"MemberTypeCompositionRequestModel": {
"required": [
"currentPropertyAliases",
"currentCompositeIds"
],
"type": "object",
"properties": {
"id": {
"type": [
"null",
"string"
],
"format": "uuid"
},
"currentPropertyAliases": {
"type": "array",
"items": {
"type": "string"
}
},
"currentCompositeIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"MemberTypeCompositionResponseModel": {
"required": [
"id",
"name",
"icon"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
}
}
},
"MemberTypeConfigurationResponseModel": {
"required": [
"reservedFieldNames"
],
"type": "object",
"properties": {
"reservedFieldNames": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MemberTypeItemResponseModel": {
"required": [
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"icon": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"MemberTypePropertyTypeContainerResponseModel": {
"required": [
"type",
"id",
"sortOrder"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": [
"null",
"string"
]
},
"type": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"MemberTypePropertyTypeResponseModel": {
"required": [
"alias",
"name",
"isSensitive",
"visibility",
"id",
"sortOrder",
"dataType",
"variesByCulture",
"variesBySegment",
"validation",
"appearance"
],
"type": "object",
"properties": {
"isSensitive": {
"type": "boolean"
},
"visibility": {
"$ref": "#/components/schemas/MemberTypePropertyTypeVisibilityModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"container": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"dataType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"validation": {
"$ref": "#/components/schemas/PropertyTypeValidationModel"
},
"appearance": {
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
}
}
},
"MemberTypePropertyTypeVisibilityModel": {
"required": [
"memberCanView",
"memberCanEdit"
],
"type": "object",
"properties": {
"memberCanView": {
"type": "boolean"
},
"memberCanEdit": {
"type": "boolean"
}
}
},
"MemberTypeReferenceResponseModel": {
"required": [
"id",
"icon"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"icon": {
"type": "string"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MemberTypeResponseModel": {
"required": [
"alias",
"name",
"icon",
"properties",
"compositions",
"id",
"allowedAsRoot",
"variesByCulture",
"variesBySegment",
"isElement",
"allowedInLibrary",
"containers"
],
"type": "object",
"properties": {
"compositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypeCompositionModel"
}
},
"id": {
"type": "string",
"format": "uuid"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"isElement": {
"type": "boolean"
},
"allowedInLibrary": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypePropertyTypeResponseModel"
}
},
"containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypePropertyTypeContainerResponseModel"
}
}
}
},
"MemberTypeTreeItemResponseModel": {
"required": [
"icon",
"isFolder",
"noAccess",
"name",
"id",
"flags",
"hasChildren"
],
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"isFolder": {
"type": "boolean"
},
"noAccess": {
"type": "boolean"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"hasChildren": {
"type": "boolean"
}
}
},
"MemberValueModel": {
"required": [
"alias"
],
"type": "object",
"properties": {
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"alias": {
"type": "string"
},
"value": {}
}
},
"MemberValueResponseModel": {
"required": [
"editorAlias",
"alias"
],
"type": "object",
"properties": {
"editorAlias": {
"type": "string"
},
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"alias": {
"type": "string"
},
"value": {}
}
},
"MemberVariantRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
}
}
},
"MemberVariantResponseModel": {
"required": [
"name",
"createDate",
"updateDate"
],
"type": "object",
"properties": {
"createDate": {
"type": "string",
"format": "date-time"
},
"updateDate": {
"type": "string",
"format": "date-time"
},
"culture": {
"type": [
"null",
"string"
]
},
"segment": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
}
}
},
"ModelsBuilderResponseModel": {
"required": [
"mode",
"canGenerate",
"outOfDateModels",
"trackingOutOfDateModels"
],
"type": "object",
"properties": {
"mode": {
"type": "string"
},
"canGenerate": {
"type": "boolean"
},
"outOfDateModels": {
"type": "boolean"
},
"lastError": {
"type": [
"null",
"string"
]
},
"version": {
"type": [
"null",
"string"
]
},
"modelsNamespace": {
"type": [
"null",
"string"
]
},
"trackingOutOfDateModels": {
"type": "boolean"
}
}
},
"MoveDataTypeRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MoveDictionaryRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MoveDocumentBlueprintRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MoveDocumentRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MoveDocumentTypeRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MoveElementRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MoveFolderRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MoveMediaRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MoveMediaTypeRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"MoveMemberTypeRequestModel": {
"type": "object",
"properties": {
"target": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
}
}
},
"NamedEntityTreeItemResponseModel": {
"required": [
"name",
"id",
"flags",
"hasChildren"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"hasChildren": {
"type": "boolean"
}
}
},
"NamedItemResponseModel": {
"required": [
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"NewsDashboardItemResponseModel": {
"required": [
"priority",
"header"
],
"type": "object",
"properties": {
"priority": {
"type": "string"
},
"header": {
"type": "string"
},
"body": {
"type": [
"null",
"string"
]
},
"buttonText": {
"type": [
"null",
"string"
]
},
"imageUrl": {
"type": [
"null",
"string"
]
},
"imageAltText": {
"type": [
"null",
"string"
]
},
"url": {
"type": [
"null",
"string"
]
}
}
},
"NewsDashboardResponseModel": {
"required": [
"items"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NewsDashboardItemResponseModel"
}
}
}
},
"NotificationHeaderModel": {
"required": [
"message",
"category",
"type"
],
"type": "object",
"properties": {
"message": {
"type": "string"
},
"category": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/EventMessageTypeModel"
}
}
},
"ObjectTypeResponseModel": {
"required": [
"id"
],
"type": "object",
"properties": {
"name": {
"type": [
"null",
"string"
]
},
"id": {
"type": "string",
"format": "uuid"
}
}
},
"OEmbedResponseModel": {
"required": [
"markup"
],
"type": "object",
"properties": {
"markup": {
"type": "string"
}
}
},
"OperatorModel": {
"enum": [
"Equals",
"NotEquals",
"Contains",
"NotContains",
"LessThan",
"LessThanEqualTo",
"GreaterThan",
"GreaterThanEqualTo"
]
},
"OutOfDateStatusResponseModel": {
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/OutOfDateTypeModel"
}
}
},
"OutOfDateTypeModel": {
"enum": [
"OutOfDate",
"Current",
"Unknown"
]
},
"PackageConfigurationResponseModel": {
"required": [
"marketplaceUrl"
],
"type": "object",
"properties": {
"marketplaceUrl": {
"type": "string"
}
}
},
"PackageDefinitionResponseModel": {
"required": [
"packagePath",
"name",
"id",
"contentLoadChildNodes",
"mediaIds",
"mediaLoadChildNodes",
"documentTypes",
"mediaTypes",
"dataTypes",
"templates",
"partialViews",
"stylesheets",
"scripts",
"languages",
"dictionaryItems"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"packagePath": {
"type": "string"
},
"name": {
"type": "string"
},
"contentNodeId": {
"type": [
"null",
"string"
]
},
"contentLoadChildNodes": {
"type": "boolean"
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"mediaLoadChildNodes": {
"type": "boolean"
},
"elementIds": {
"type": [
"null",
"array"
],
"items": {
"type": "string",
"format": "uuid"
}
},
"documentTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"mediaTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"dataTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"templates": {
"type": "array",
"items": {
"type": "string"
}
},
"partialViews": {
"type": "array",
"items": {
"type": "string"
}
},
"stylesheets": {
"type": "array",
"items": {
"type": "string"
}
},
"scripts": {
"type": "array",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"dictionaryItems": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PackageMigrationStatusResponseModel": {
"required": [
"packageName",
"hasPendingMigrations"
],
"type": "object",
"properties": {
"packageName": {
"type": "string"
},
"hasPendingMigrations": {
"type": "boolean"
}
}
},
"PagedAllowedDocumentTypeModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllowedDocumentTypeModel"
}
}
}
},
"PagedAllowedMediaTypeModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllowedMediaTypeModel"
}
}
}
},
"PagedAllowedMemberTypeModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllowedMemberTypeModel"
}
}
}
},
"PagedAuditLogResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditLogResponseModel"
}
}
}
},
"PagedCultureReponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CultureReponseModel"
}
}
}
},
"PagedDataTypeItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypeItemResponseModel"
}
}
}
},
"PagedDataTypeTreeItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypeTreeItemResponseModel"
}
}
}
},
"PagedDictionaryOverviewResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryOverviewResponseModel"
}
}
}
},
"PagedDocumentBlueprintTreeItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentBlueprintTreeItemResponseModel"
}
}
}
},
"PagedDocumentCollectionResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCollectionResponseModel"
}
}
}
},
"PagedDocumentRecycleBinItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentRecycleBinItemResponseModel"
}
}
}
},
"PagedDocumentTreeItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTreeItemResponseModel"
}
}
}
},
"PagedDocumentTypeBlueprintItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeBlueprintItemResponseModel"
}
}
}
},
"PagedDocumentTypeTreeItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeTreeItemResponseModel"
}
}
}
},
"PagedDocumentVersionItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVersionItemResponseModel"
}
}
}
},
"PagedElementRecycleBinItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementRecycleBinItemResponseModel"
}
}
}
},
"PagedElementTreeItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementTreeItemResponseModel"
}
}
}
},
"PagedElementVersionItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVersionItemResponseModel"
}
}
}
},
"PagedFileSystemTreeItemPresentationModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
}
}
}
},
"PagedHealthCheckGroupResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthCheckGroupResponseModel"
}
}
}
},
"PagedHelpPageResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HelpPageResponseModel"
}
}
}
},
"PagedIndexResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexResponseModel"
}
}
}
},
"PagedIReferenceResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IReferenceResponseModel"
}
}
}
},
"PagedLanguageResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageResponseModel"
}
}
}
},
"PagedLoggerResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoggerResponseModel"
}
}
}
},
"PagedLogMessageResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogMessageResponseModel"
}
}
}
},
"PagedLogTemplateResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogTemplateResponseModel"
}
}
}
},
"PagedMediaCollectionResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaCollectionResponseModel"
}
}
}
},
"PagedMediaRecycleBinItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaRecycleBinItemResponseModel"
}
}
}
},
"PagedMediaTreeItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTreeItemResponseModel"
}
}
}
},
"PagedMediaTypeTreeItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeTreeItemResponseModel"
}
}
}
},
"PagedMemberGroupResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberGroupResponseModel"
}
}
}
},
"PagedMemberResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberResponseModel"
}
}
}
},
"PagedMemberTypeTreeItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypeTreeItemResponseModel"
}
}
}
},
"PagedModelAllowedMediaTypeItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllowedMediaTypeItemResponseModel"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"PagedModelDataTypeItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypeItemResponseModel"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"PagedModelDocumentItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentItemResponseModel"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"PagedModelDocumentTypeItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeItemResponseModel"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"PagedModelElementItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementItemResponseModel"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"PagedModelMediaItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaItemResponseModel"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"PagedModelMediaTypeItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeItemResponseModel"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"PagedModelMemberItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberItemResponseModel"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"PagedModelMemberTypeItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypeItemResponseModel"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"PagedModelTemplateItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateItemResponseModel"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"PagedNamedEntityTreeItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NamedEntityTreeItemResponseModel"
}
}
}
},
"PagedObjectTypeResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectTypeResponseModel"
}
}
}
},
"PagedPackageDefinitionResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageDefinitionResponseModel"
}
}
}
},
"PagedPackageMigrationStatusResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageMigrationStatusResponseModel"
}
}
}
},
"PagedPartialViewSnippetItemResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartialViewSnippetItemResponseModel"
}
}
}
},
"PagedProblemDetailsModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"PagedRedirectUrlResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RedirectUrlResponseModel"
}
}
}
},
"PagedReferenceByIdModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"PagedRelationResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelationResponseModel"
}
}
}
},
"PagedRelationTypeResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelationTypeResponseModel"
}
}
}
},
"PagedSavedLogSearchResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedLogSearchResponseModel"
}
}
}
},
"PagedSearcherResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearcherResponseModel"
}
}
}
},
"PagedSearchResultResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchResultResponseModel"
}
}
}
},
"PagedSegmentResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SegmentResponseModel"
}
}
}
},
"PagedTagResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagResponseModel"
}
}
}
},
"PagedTelemetryResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TelemetryResponseModel"
}
}
}
},
"PagedUserDataResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDataResponseModel"
}
}
}
},
"PagedUserGroupResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserGroupResponseModel"
}
}
}
},
"PagedUserResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponseModel"
}
}
}
},
"PagedWebhookEventModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookEventModel"
}
}
}
},
"PagedWebhookLogResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookLogResponseModel"
}
}
}
},
"PagedWebhookResponseModel": {
"required": [
"total",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookResponseModel"
}
}
}
},
"PartialViewFolderResponseModel": {
"required": [
"name",
"path"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
},
"path": {
"type": "string"
}
}
},
"PartialViewItemResponseModel": {
"required": [
"isFolder",
"name",
"path"
],
"type": "object",
"properties": {
"isFolder": {
"type": "boolean"
},
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
},
"path": {
"type": "string"
}
}
},
"PartialViewResponseModel": {
"required": [
"content",
"name",
"path"
],
"type": "object",
"properties": {
"content": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
},
"path": {
"type": "string"
}
}
},
"PartialViewSnippetItemResponseModel": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"PartialViewSnippetResponseModel": {
"required": [
"content",
"id",
"name"
],
"type": "object",
"properties": {
"content": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"PasswordConfigurationResponseModel": {
"required": [
"minimumPasswordLength",
"requireNonLetterOrDigit",
"requireDigit",
"requireLowercase",
"requireUppercase"
],
"type": "object",
"properties": {
"minimumPasswordLength": {
"type": "integer",
"format": "int32"
},
"requireNonLetterOrDigit": {
"type": "boolean"
},
"requireDigit": {
"type": "boolean"
},
"requireLowercase": {
"type": "boolean"
},
"requireUppercase": {
"type": "boolean"
}
}
},
"PatchDocumentRequestModel": {
"required": [
"operations"
],
"type": "object",
"properties": {
"operations": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/PatchOperationRequestModel"
}
}
}
},
"PatchOperationRequestModel": {
"required": [
"op",
"path"
],
"type": "object",
"properties": {
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"value": {}
}
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": [
"null",
"string"
]
},
"title": {
"type": [
"null",
"string"
]
},
"status": {
"type": [
"null",
"integer"
],
"format": "int32"
},
"detail": {
"type": [
"null",
"string"
]
},
"instance": {
"type": [
"null",
"string"
]
}
}
},
"ProblemDetailsBuilderModel": {
"type": "object"
},
"ProfilingStatusRequestModel": {
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"ProfilingStatusResponseModel": {
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"PropertyTypeAppearanceModel": {
"required": [
"labelOnTop"
],
"type": "object",
"properties": {
"labelOnTop": {
"type": "boolean"
}
}
},
"PropertyTypeValidationModel": {
"required": [
"mandatory"
],
"type": "object",
"properties": {
"mandatory": {
"type": "boolean"
},
"mandatoryMessage": {
"type": [
"null",
"string"
]
},
"regEx": {
"type": [
"null",
"string"
]
},
"regExMessage": {
"type": [
"null",
"string"
]
}
}
},
"PublicAccessRequestModel": {
"required": [
"loginDocument",
"errorDocument",
"memberUserNames",
"memberGroupNames"
],
"type": "object",
"properties": {
"memberUserNames": {
"type": "array",
"items": {
"type": "string"
}
},
"memberGroupNames": {
"type": "array",
"items": {
"type": "string"
}
},
"loginDocument": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"errorDocument": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
},
"PublicAccessResponseModel": {
"required": [
"loginDocument",
"errorDocument",
"members",
"groups",
"isProtectedByAncestor"
],
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberItemResponseModel"
}
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberGroupItemResponseModel"
}
},
"isProtectedByAncestor": {
"type": "boolean"
},
"loginDocument": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"errorDocument": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
},
"PublishableVariantStateModel": {
"enum": [
"NotCreated",
"Draft",
"Published",
"PublishedPendingChanges",
"Trashed"
]
},
"PublishDocumentRequestModel": {
"required": [
"publishSchedules"
],
"type": "object",
"properties": {
"publishSchedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CultureAndScheduleRequestModel"
}
}
}
},
"PublishDocumentWithDescendantsRequestModel": {
"required": [
"cultures",
"includeUnpublishedDescendants"
],
"type": "object",
"properties": {
"includeUnpublishedDescendants": {
"type": "boolean"
},
"cultures": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PublishedDocumentResponseModel": {
"required": [
"isTrashed",
"documentType",
"id",
"flags",
"values",
"variants"
],
"type": "object",
"properties": {
"template": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"isTrashed": {
"type": "boolean"
},
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueResponseModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantResponseModel"
}
}
}
},
"PublishedElementResponseModel": {
"required": [
"isTrashed",
"documentType",
"id",
"flags",
"values",
"variants"
],
"type": "object",
"properties": {
"isTrashed": {
"type": "boolean"
},
"documentType": {
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementValueResponseModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantResponseModel"
}
}
}
},
"PublishElementRequestModel": {
"required": [
"publishSchedules"
],
"type": "object",
"properties": {
"publishSchedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CultureAndScheduleRequestModel"
}
}
}
},
"PublishWithDescendantsResultModel": {
"required": [
"taskId",
"isComplete"
],
"type": "object",
"properties": {
"taskId": {
"type": "string",
"format": "uuid"
},
"isComplete": {
"type": "boolean"
}
}
},
"RebuildStatusModel": {
"required": [
"isRebuilding"
],
"type": "object",
"properties": {
"isRebuilding": {
"type": "boolean"
}
}
},
"RedirectStatusModel": {
"enum": [
"Enabled",
"Disabled"
]
},
"RedirectUrlResponseModel": {
"required": [
"originalUrl",
"destinationUrl",
"document",
"id",
"created"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"originalUrl": {
"type": "string"
},
"destinationUrl": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time"
},
"document": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"culture": {
"type": [
"null",
"string"
]
}
}
},
"RedirectUrlStatusResponseModel": {
"required": [
"status",
"userIsAdmin"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/RedirectStatusModel"
},
"userIsAdmin": {
"type": "boolean"
}
}
},
"ReferenceByIdModel": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
}
},
"RelationReferenceModel": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"RelationResponseModel": {
"required": [
"relationType",
"parent",
"child",
"id",
"createDate"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"relationType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"parent": {
"$ref": "#/components/schemas/RelationReferenceModel"
},
"child": {
"$ref": "#/components/schemas/RelationReferenceModel"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"comment": {
"type": [
"null",
"string"
]
}
}
},
"RelationTypeItemResponseModel": {
"required": [
"isDeletable",
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"isDeletable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"RelationTypeResponseModel": {
"required": [
"name",
"id",
"isBidirectional",
"isDependency"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"alias": {
"type": [
"null",
"string"
]
},
"parentObject": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ObjectTypeResponseModel"
}
]
},
"childObject": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ObjectTypeResponseModel"
}
]
},
"name": {
"type": "string"
},
"isBidirectional": {
"type": "boolean"
},
"isDependency": {
"type": "boolean"
}
}
},
"RenamePartialViewRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"RenameScriptRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"RenameStylesheetRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"ResendInviteUserRequestModel": {
"required": [
"user"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"message": {
"type": [
"null",
"string"
]
}
}
},
"ResetPasswordRequestModel": {
"required": [
"email"
],
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"ResetPasswordTokenRequestModel": {
"required": [
"password",
"user",
"resetCode"
],
"type": "object",
"properties": {
"password": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"resetCode": {
"type": "string"
}
}
},
"ResetPasswordUserResponseModel": {
"type": "object",
"properties": {
"resetPassword": {
"type": [
"null",
"string"
]
}
}
},
"RuntimeLevelModel": {
"enum": [
"Unknown",
"Boot",
"Install",
"Upgrade",
"Upgrading",
"Run",
"BootFailed"
]
},
"RuntimeModeModel": {
"enum": [
"BackofficeDevelopment",
"Development",
"Production"
]
},
"SavedLogSearchRequestModel": {
"required": [
"name",
"query"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"query": {
"type": "string"
}
}
},
"SavedLogSearchResponseModel": {
"required": [
"name",
"query"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"query": {
"type": "string"
}
}
},
"ScheduleRequestModel": {
"type": "object",
"properties": {
"publishTime": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"unpublishTime": {
"type": [
"null",
"string"
],
"format": "date-time"
}
}
},
"ScriptFolderResponseModel": {
"required": [
"name",
"path"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
},
"path": {
"type": "string"
}
}
},
"ScriptItemResponseModel": {
"required": [
"isFolder",
"name",
"path"
],
"type": "object",
"properties": {
"isFolder": {
"type": "boolean"
},
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
},
"path": {
"type": "string"
}
}
},
"ScriptResponseModel": {
"required": [
"content",
"name",
"path"
],
"type": "object",
"properties": {
"content": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
},
"path": {
"type": "string"
}
}
},
"SearcherResponseModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"SearchResultResponseModel": {
"required": [
"id",
"score",
"fieldCount",
"fields"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"score": {
"type": "number",
"format": "float"
},
"fieldCount": {
"type": "integer",
"format": "int32"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldPresentationModel"
}
}
}
},
"SecurityConfigurationResponseModel": {
"required": [
"passwordConfiguration"
],
"type": "object",
"properties": {
"passwordConfiguration": {
"$ref": "#/components/schemas/PasswordConfigurationResponseModel"
}
}
},
"SegmentResponseModel": {
"required": [
"name",
"alias"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"cultures": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
}
}
},
"ServerConfigurationItemResponseModel": {
"required": [
"name",
"data"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "string"
}
}
},
"ServerConfigurationResponseModel": {
"required": [
"allowPasswordReset",
"versionCheckPeriod",
"allowLocalLogin",
"umbracoCssPath",
"signalR"
],
"type": "object",
"properties": {
"allowPasswordReset": {
"type": "boolean"
},
"versionCheckPeriod": {
"type": "integer",
"format": "int32"
},
"allowLocalLogin": {
"type": "boolean"
},
"umbracoCssPath": {
"type": "string"
},
"signalR": {
"$ref": "#/components/schemas/SignalRClientSettingsResponseModel"
}
}
},
"ServerInformationResponseModel": {
"required": [
"version",
"assemblyVersion",
"baseUtcOffset",
"runtimeMode"
],
"type": "object",
"properties": {
"version": {
"type": "string"
},
"assemblyVersion": {
"type": "string"
},
"baseUtcOffset": {
"type": "string"
},
"runtimeMode": {
"$ref": "#/components/schemas/RuntimeModeModel"
}
}
},
"ServerStatusResponseModel": {
"required": [
"serverStatus"
],
"type": "object",
"properties": {
"serverStatus": {
"$ref": "#/components/schemas/RuntimeLevelModel"
}
}
},
"ServerTroubleshootingResponseModel": {
"required": [
"items"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServerConfigurationItemResponseModel"
}
}
}
},
"SetAvatarRequestModel": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
},
"SignalRClientSettingsResponseModel": {
"required": [
"skipNegotiation"
],
"type": "object",
"properties": {
"skipNegotiation": {
"type": "boolean"
}
}
},
"SortDocumentChildrenByFieldRequestModel": {
"required": [
"field",
"direction"
],
"type": "object",
"properties": {
"culture": {
"type": [
"null",
"string"
]
},
"field": {
"$ref": "#/components/schemas/ContentSortFieldModel"
},
"direction": {
"$ref": "#/components/schemas/DirectionModel"
}
}
},
"SortingRequestModel": {
"required": [
"sorting"
],
"type": "object",
"properties": {
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"sorting": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemSortingRequestModel"
}
}
}
},
"SortMediaChildrenByFieldRequestModel": {
"required": [
"field",
"direction"
],
"type": "object",
"properties": {
"field": {
"$ref": "#/components/schemas/ContentSortFieldModel"
},
"direction": {
"$ref": "#/components/schemas/DirectionModel"
}
}
},
"StaticFileItemResponseModel": {
"required": [
"isFolder",
"name",
"path"
],
"type": "object",
"properties": {
"isFolder": {
"type": "boolean"
},
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
},
"path": {
"type": "string"
}
}
},
"StatusResultTypeModel": {
"enum": [
"Success",
"Warning",
"Error",
"Info"
]
},
"StylesheetFolderResponseModel": {
"required": [
"name",
"path"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
},
"path": {
"type": "string"
}
}
},
"StylesheetItemResponseModel": {
"required": [
"isFolder",
"name",
"path"
],
"type": "object",
"properties": {
"isFolder": {
"type": "boolean"
},
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
},
"path": {
"type": "string"
}
}
},
"StylesheetResponseModel": {
"required": [
"content",
"name",
"path"
],
"type": "object",
"properties": {
"content": {
"type": "string"
},
"name": {
"type": "string"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/FileSystemFolderModel"
}
]
},
"path": {
"type": "string"
}
}
},
"SubsetDataTypeTreeItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypeTreeItemResponseModel"
}
}
}
},
"SubsetDocumentBlueprintTreeItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentBlueprintTreeItemResponseModel"
}
}
}
},
"SubsetDocumentRecycleBinItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentRecycleBinItemResponseModel"
}
}
}
},
"SubsetDocumentTreeItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTreeItemResponseModel"
}
}
}
},
"SubsetDocumentTypeTreeItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeTreeItemResponseModel"
}
}
}
},
"SubsetElementRecycleBinItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementRecycleBinItemResponseModel"
}
}
}
},
"SubsetElementTreeItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementTreeItemResponseModel"
}
}
}
},
"SubsetFileSystemTreeItemPresentationModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
}
}
}
},
"SubsetMediaRecycleBinItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaRecycleBinItemResponseModel"
}
}
}
},
"SubsetMediaTreeItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTreeItemResponseModel"
}
}
}
},
"SubsetMediaTypeTreeItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeTreeItemResponseModel"
}
}
}
},
"SubsetMemberTypeTreeItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypeTreeItemResponseModel"
}
}
}
},
"SubsetNamedEntityTreeItemResponseModel": {
"required": [
"totalBefore",
"totalAfter",
"items"
],
"type": "object",
"properties": {
"totalBefore": {
"type": "integer",
"format": "int64"
},
"totalAfter": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NamedEntityTreeItemResponseModel"
}
}
}
},
"TagResponseModel": {
"required": [
"id",
"nodeCount"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"text": {
"type": [
"null",
"string"
]
},
"group": {
"type": [
"null",
"string"
]
},
"nodeCount": {
"type": "integer",
"format": "int32"
}
}
},
"TelemetryLevelModel": {
"enum": [
"Minimal",
"Basic",
"Detailed"
]
},
"TelemetryRequestModel": {
"required": [
"telemetryLevel"
],
"type": "object",
"properties": {
"telemetryLevel": {
"$ref": "#/components/schemas/TelemetryLevelModel"
}
}
},
"TelemetryResponseModel": {
"required": [
"telemetryLevel"
],
"type": "object",
"properties": {
"telemetryLevel": {
"$ref": "#/components/schemas/TelemetryLevelModel"
}
}
},
"TemplateConfigurationResponseModel": {
"required": [
"disabled"
],
"type": "object",
"properties": {
"disabled": {
"type": "boolean"
}
}
},
"TemplateItemResponseModel": {
"required": [
"alias",
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"TemplateQueryExecuteFilterPresentationModel": {
"required": [
"propertyAlias",
"constraintValue",
"operator"
],
"type": "object",
"properties": {
"propertyAlias": {
"type": "string"
},
"constraintValue": {
"type": "string"
},
"operator": {
"$ref": "#/components/schemas/OperatorModel"
}
}
},
"TemplateQueryExecuteModel": {
"required": [
"take"
],
"type": "object",
"properties": {
"rootDocument": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"documentTypeAlias": {
"type": [
"null",
"string"
]
},
"filters": {
"type": [
"null",
"array"
],
"items": {
"$ref": "#/components/schemas/TemplateQueryExecuteFilterPresentationModel"
}
},
"sort": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/TemplateQueryExecuteSortModel"
}
]
},
"take": {
"type": "integer",
"format": "int32"
}
}
},
"TemplateQueryExecuteSortModel": {
"required": [
"propertyAlias"
],
"type": "object",
"properties": {
"propertyAlias": {
"type": "string"
},
"direction": {
"type": [
"null",
"string"
]
}
}
},
"TemplateQueryOperatorModel": {
"required": [
"operator",
"applicableTypes"
],
"type": "object",
"properties": {
"operator": {
"$ref": "#/components/schemas/OperatorModel"
},
"applicableTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateQueryPropertyTypeModel"
}
}
}
},
"TemplateQueryPropertyPresentationModel": {
"required": [
"alias",
"type"
],
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateQueryPropertyTypeModel"
}
}
},
"TemplateQueryPropertyTypeModel": {
"enum": [
"String",
"DateTime",
"Integer"
]
},
"TemplateQueryResultItemPresentationModel": {
"required": [
"icon",
"name"
],
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"TemplateQueryResultResponseModel": {
"required": [
"queryExpression",
"sampleResults",
"resultCount",
"executionTime"
],
"type": "object",
"properties": {
"queryExpression": {
"type": "string"
},
"sampleResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateQueryResultItemPresentationModel"
}
},
"resultCount": {
"type": "integer",
"format": "int32"
},
"executionTime": {
"type": "integer",
"format": "int64"
}
}
},
"TemplateQuerySettingsResponseModel": {
"required": [
"documentTypeAliases",
"properties",
"operators"
],
"type": "object",
"properties": {
"documentTypeAliases": {
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateQueryPropertyPresentationModel"
}
},
"operators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateQueryOperatorModel"
}
}
}
},
"TemplateResponseModel": {
"required": [
"name",
"alias",
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"layoutTemplate": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"masterTemplate": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"content": {
"type": [
"null",
"string"
]
}
}
},
"TemporaryFileConfigurationResponseModel": {
"required": [
"imageFileTypes",
"disallowedUploadedFilesExtensions",
"allowedUploadedFileExtensions"
],
"type": "object",
"properties": {
"imageFileTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"disallowedUploadedFilesExtensions": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedUploadedFileExtensions": {
"type": "array",
"items": {
"type": "string"
}
},
"maxFileSize": {
"type": [
"null",
"integer"
],
"format": "int64"
}
}
},
"TemporaryFileResponseModel": {
"required": [
"fileName",
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"availableUntil": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"fileName": {
"type": "string"
}
}
},
"TrackedReferenceDocumentTypeModel": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"icon": {
"type": [
"null",
"string"
]
},
"alias": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"TrackedReferenceMediaTypeModel": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"icon": {
"type": [
"null",
"string"
]
},
"alias": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"TrackedReferenceMemberTypeModel": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"icon": {
"type": [
"null",
"string"
]
},
"alias": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"TreeItemKindModel": {
"type": "string"
},
"UnlockUsersRequestModel": {
"required": [
"userIds"
],
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"UnpublishDocumentRequestModel": {
"type": "object",
"properties": {
"cultures": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
}
}
},
"UnpublishElementRequestModel": {
"type": "object",
"properties": {
"cultures": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
}
}
},
"UpdateAndPublishDocumentRequestModel": {
"required": [
"culturesToPublish",
"values",
"variants"
],
"type": "object",
"properties": {
"culturesToPublish": {
"type": "array",
"items": {
"type": "string"
}
},
"template": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantRequestModel"
}
}
}
},
"UpdateAndPublishElementRequestModel": {
"required": [
"culturesToPublish",
"values",
"variants"
],
"type": "object",
"properties": {
"culturesToPublish": {
"type": "array",
"items": {
"type": "string"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantRequestModel"
}
}
}
},
"UpdateCurrentUserRequestModel": {
"required": [
"languageIsoCode"
],
"type": "object",
"properties": {
"languageIsoCode": {
"type": "string"
}
}
},
"UpdateDataTypeRequestModel": {
"required": [
"name",
"editorAlias",
"editorUiAlias",
"values"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"editorAlias": {
"type": "string"
},
"editorUiAlias": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypePropertyPresentationModel"
}
}
}
},
"UpdateDictionaryItemRequestModel": {
"required": [
"name",
"translations"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryItemTranslationModel"
}
}
}
},
"UpdateDocumentBlueprintRequestModel": {
"required": [
"values",
"variants"
],
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantRequestModel"
}
}
}
},
"UpdateDocumentNotificationsRequestModel": {
"required": [
"subscribedActionIds"
],
"type": "object",
"properties": {
"subscribedActionIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"UpdateDocumentRequestModel": {
"required": [
"values",
"variants"
],
"type": "object",
"properties": {
"template": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantRequestModel"
}
}
}
},
"UpdateDocumentTypePropertyTypeContainerRequestModel": {
"required": [
"type",
"id",
"sortOrder"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": [
"null",
"string"
]
},
"type": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"UpdateDocumentTypePropertyTypeRequestModel": {
"required": [
"alias",
"name",
"id",
"sortOrder",
"dataType",
"variesByCulture",
"variesBySegment",
"validation",
"appearance"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"container": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"dataType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"validation": {
"$ref": "#/components/schemas/PropertyTypeValidationModel"
},
"appearance": {
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
}
}
},
"UpdateDocumentTypeRequestModel": {
"required": [
"alias",
"name",
"icon",
"properties",
"allowedTemplates",
"cleanup",
"allowedDocumentTypes",
"compositions",
"allowedAsRoot",
"variesByCulture",
"variesBySegment",
"isElement",
"allowedInLibrary",
"containers"
],
"type": "object",
"properties": {
"allowedTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"defaultTemplate": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"cleanup": {
"$ref": "#/components/schemas/DocumentTypeCleanupModel"
},
"allowedDocumentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeSortModel"
}
},
"compositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeCompositionModel"
}
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"isElement": {
"type": "boolean"
},
"allowedInLibrary": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateDocumentTypePropertyTypeRequestModel"
}
},
"containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateDocumentTypePropertyTypeContainerRequestModel"
}
}
}
},
"UpdateDomainsRequestModel": {
"required": [
"domains"
],
"type": "object",
"properties": {
"defaultIsoCode": {
"type": [
"null",
"string"
]
},
"domains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DomainPresentationModel"
}
}
}
},
"UpdateElementRequestModel": {
"required": [
"values",
"variants"
],
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantRequestModel"
}
}
}
},
"UpdateFolderResponseModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"UpdateLanguageRequestModel": {
"required": [
"name",
"isDefault",
"isMandatory"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"isMandatory": {
"type": "boolean"
},
"fallbackIsoCode": {
"type": [
"null",
"string"
]
}
}
},
"UpdateMediaRequestModel": {
"required": [
"values",
"variants"
],
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaVariantRequestModel"
}
}
}
},
"UpdateMediaTypePropertyTypeContainerRequestModel": {
"required": [
"type",
"id",
"sortOrder"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": [
"null",
"string"
]
},
"type": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"UpdateMediaTypePropertyTypeRequestModel": {
"required": [
"alias",
"name",
"id",
"sortOrder",
"dataType",
"variesByCulture",
"variesBySegment",
"validation",
"appearance"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"container": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"dataType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"validation": {
"$ref": "#/components/schemas/PropertyTypeValidationModel"
},
"appearance": {
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
}
}
},
"UpdateMediaTypeRequestModel": {
"required": [
"alias",
"name",
"icon",
"properties",
"allowedMediaTypes",
"compositions",
"allowedAsRoot",
"variesByCulture",
"variesBySegment",
"isElement",
"allowedInLibrary",
"containers"
],
"type": "object",
"properties": {
"allowedMediaTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeSortModel"
}
},
"compositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeCompositionModel"
}
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"isElement": {
"type": "boolean"
},
"allowedInLibrary": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateMediaTypePropertyTypeRequestModel"
}
},
"containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateMediaTypePropertyTypeContainerRequestModel"
}
}
}
},
"UpdateMemberGroupRequestModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"UpdateMemberRequestModel": {
"required": [
"email",
"username",
"isApproved",
"isLockedOut",
"isTwoFactorEnabled",
"values",
"variants"
],
"type": "object",
"properties": {
"email": {
"type": "string"
},
"username": {
"type": "string"
},
"oldPassword": {
"type": [
"null",
"string"
]
},
"newPassword": {
"type": [
"null",
"string"
]
},
"groups": {
"type": [
"null",
"array"
],
"items": {
"type": "string",
"format": "uuid"
}
},
"isApproved": {
"type": "boolean"
},
"isLockedOut": {
"type": "boolean"
},
"isTwoFactorEnabled": {
"type": "boolean"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberVariantRequestModel"
}
}
}
},
"UpdateMemberTypePropertyTypeContainerRequestModel": {
"required": [
"type",
"id",
"sortOrder"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parent": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"name": {
"type": [
"null",
"string"
]
},
"type": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
"UpdateMemberTypePropertyTypeRequestModel": {
"required": [
"alias",
"name",
"isSensitive",
"visibility",
"id",
"sortOrder",
"dataType",
"variesByCulture",
"variesBySegment",
"validation",
"appearance"
],
"type": "object",
"properties": {
"isSensitive": {
"type": "boolean"
},
"visibility": {
"$ref": "#/components/schemas/MemberTypePropertyTypeVisibilityModel"
},
"id": {
"type": "string",
"format": "uuid"
},
"container": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"dataType": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"validation": {
"$ref": "#/components/schemas/PropertyTypeValidationModel"
},
"appearance": {
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
}
}
},
"UpdateMemberTypeRequestModel": {
"required": [
"alias",
"name",
"icon",
"properties",
"compositions",
"allowedAsRoot",
"variesByCulture",
"variesBySegment",
"isElement",
"allowedInLibrary",
"containers"
],
"type": "object",
"properties": {
"compositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberTypeCompositionModel"
}
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"collection": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"isElement": {
"type": "boolean"
},
"allowedInLibrary": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateMemberTypePropertyTypeRequestModel"
}
},
"containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateMemberTypePropertyTypeContainerRequestModel"
}
}
}
},
"UpdatePackageRequestModel": {
"required": [
"packagePath",
"name",
"contentLoadChildNodes",
"mediaIds",
"mediaLoadChildNodes",
"documentTypes",
"mediaTypes",
"dataTypes",
"templates",
"partialViews",
"stylesheets",
"scripts",
"languages",
"dictionaryItems"
],
"type": "object",
"properties": {
"packagePath": {
"type": "string"
},
"name": {
"type": "string"
},
"contentNodeId": {
"type": [
"null",
"string"
]
},
"contentLoadChildNodes": {
"type": "boolean"
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"mediaLoadChildNodes": {
"type": "boolean"
},
"elementIds": {
"type": [
"null",
"array"
],
"items": {
"type": "string",
"format": "uuid"
}
},
"documentTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"mediaTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"dataTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"templates": {
"type": "array",
"items": {
"type": "string"
}
},
"partialViews": {
"type": "array",
"items": {
"type": "string"
}
},
"stylesheets": {
"type": "array",
"items": {
"type": "string"
}
},
"scripts": {
"type": "array",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"dictionaryItems": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"UpdatePartialViewRequestModel": {
"required": [
"content"
],
"type": "object",
"properties": {
"content": {
"type": "string"
}
}
},
"UpdateScriptRequestModel": {
"required": [
"content"
],
"type": "object",
"properties": {
"content": {
"type": "string"
}
}
},
"UpdateStylesheetRequestModel": {
"required": [
"content"
],
"type": "object",
"properties": {
"content": {
"type": "string"
}
}
},
"UpdateTemplateRequestModel": {
"required": [
"name",
"alias"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"content": {
"type": [
"null",
"string"
]
}
}
},
"UpdateUserDataRequestModel": {
"required": [
"key",
"group",
"identifier",
"value"
],
"type": "object",
"properties": {
"key": {
"type": "string",
"format": "uuid"
},
"group": {
"type": "string"
},
"identifier": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"UpdateUserGroupRequestModel": {
"required": [
"name",
"alias",
"sections",
"languages",
"hasAccessToAllLanguages",
"fallbackPermissions",
"permissions",
"documentRootAccess",
"mediaRootAccess",
"elementRootAccess"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": [
"null",
"string"
]
},
"sections": {
"type": "array",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"hasAccessToAllLanguages": {
"type": "boolean"
},
"documentStartNode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"documentRootAccess": {
"type": "boolean"
},
"mediaStartNode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"mediaRootAccess": {
"type": "boolean"
},
"elementStartNode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"elementRootAccess": {
"type": "boolean"
},
"fallbackPermissions": {
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPermissionPresentationModel"
}
}
}
},
"UpdateUserGroupsOnUserRequestModel": {
"required": [
"userIds",
"userGroupIds"
],
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"userGroupIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"UpdateUserRequestModel": {
"required": [
"languageIsoCode",
"documentStartNodeIds",
"hasDocumentRootAccess",
"mediaStartNodeIds",
"hasMediaRootAccess",
"elementStartNodeIds",
"hasElementRootAccess",
"email",
"userName",
"name",
"userGroupIds"
],
"type": "object",
"properties": {
"languageIsoCode": {
"type": "string"
},
"documentStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasDocumentRootAccess": {
"type": "boolean"
},
"mediaStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasMediaRootAccess": {
"type": "boolean"
},
"elementStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasElementRootAccess": {
"type": "boolean"
},
"email": {
"type": "string"
},
"userName": {
"type": "string"
},
"name": {
"type": "string"
},
"userGroupIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"UpdateWebhookRequestModel": {
"required": [
"url",
"events",
"enabled",
"contentTypeKeys",
"headers"
],
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"enabled": {
"type": "boolean"
},
"name": {
"type": [
"null",
"string"
]
},
"description": {
"type": [
"null",
"string"
]
},
"url": {
"type": "string"
},
"contentTypeKeys": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"UpgradeCheckResponseModel": {
"required": [
"type",
"comment",
"url"
],
"type": "object",
"properties": {
"type": {
"type": "string"
},
"comment": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"UpgradeSettingsResponseModel": {
"required": [
"currentState",
"newState",
"newVersion",
"oldVersion",
"reportUrl"
],
"type": "object",
"properties": {
"currentState": {
"type": "string"
},
"newState": {
"type": "string"
},
"newVersion": {
"type": "string"
},
"oldVersion": {
"type": "string"
},
"reportUrl": {
"type": [
"null",
"string"
]
}
}
},
"UserConfigurationResponseModel": {
"required": [
"passwordConfiguration",
"canInviteUsers",
"usernameIsEmail",
"allowChangePassword",
"allowTwoFactor"
],
"type": "object",
"properties": {
"canInviteUsers": {
"type": "boolean"
},
"usernameIsEmail": {
"type": "boolean"
},
"passwordConfiguration": {
"$ref": "#/components/schemas/PasswordConfigurationResponseModel"
},
"allowChangePassword": {
"type": "boolean"
},
"allowTwoFactor": {
"type": "boolean"
}
}
},
"UserDataModel": {
"required": [
"group",
"identifier",
"value"
],
"type": "object",
"properties": {
"group": {
"type": "string"
},
"identifier": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"UserDataOperationStatusModel": {
"enum": [
"Success",
"NotFound",
"UserNotFound",
"AlreadyExists"
]
},
"UserDataResponseModel": {
"required": [
"key",
"group",
"identifier",
"value"
],
"type": "object",
"properties": {
"key": {
"type": "string",
"format": "uuid"
},
"group": {
"type": "string"
},
"identifier": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"UserExternalLoginProviderModel": {
"required": [
"providerSchemeName",
"providerKey",
"isLinkedOnUser",
"hasManualLinkingEnabled"
],
"type": "object",
"properties": {
"providerSchemeName": {
"type": "string"
},
"providerKey": {
"type": [
"null",
"string"
]
},
"isLinkedOnUser": {
"type": "boolean"
},
"hasManualLinkingEnabled": {
"type": "boolean"
}
}
},
"UserGroupItemResponseModel": {
"required": [
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"icon": {
"type": [
"null",
"string"
]
},
"alias": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"UserGroupResponseModel": {
"required": [
"id",
"name",
"alias",
"sections",
"languages",
"hasAccessToAllLanguages",
"fallbackPermissions",
"permissions",
"isDeletable",
"aliasCanBeChanged",
"documentRootAccess",
"mediaRootAccess",
"elementRootAccess"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"isDeletable": {
"type": "boolean"
},
"aliasCanBeChanged": {
"type": "boolean"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"icon": {
"type": [
"null",
"string"
]
},
"sections": {
"type": "array",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"hasAccessToAllLanguages": {
"type": "boolean"
},
"documentStartNode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"documentRootAccess": {
"type": "boolean"
},
"mediaStartNode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"mediaRootAccess": {
"type": "boolean"
},
"elementStartNode": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"elementRootAccess": {
"type": "boolean"
},
"fallbackPermissions": {
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPermissionPresentationModel"
}
}
}
},
"UserInstallRequestModel": {
"required": [
"name",
"email",
"password",
"subscribeToNewsletter"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"subscribeToNewsletter": {
"type": "boolean"
}
}
},
"UserItemResponseModel": {
"required": [
"avatarUrls",
"kind",
"name",
"id",
"flags"
],
"type": "object",
"properties": {
"avatarUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"kind": {
"$ref": "#/components/schemas/UserKindModel"
},
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"UserKindModel": {
"enum": [
"Default",
"Api"
]
},
"UserOrderModel": {
"enum": [
"UserName",
"Language",
"Name",
"Email",
"Id",
"CreateDate",
"UpdateDate",
"IsApproved",
"IsLockedOut",
"LastLoginDate"
]
},
"UserPermissionModel": {
"required": [
"nodeKey",
"permissions"
],
"type": "object",
"properties": {
"nodeKey": {
"type": "string",
"format": "uuid"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"UserPermissionsResponseModel": {
"required": [
"permissions"
],
"type": "object",
"properties": {
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserPermissionModel"
}
}
}
},
"UserResponseModel": {
"required": [
"id",
"documentStartNodeIds",
"hasDocumentRootAccess",
"mediaStartNodeIds",
"hasMediaRootAccess",
"elementStartNodeIds",
"hasElementRootAccess",
"avatarUrls",
"state",
"failedLoginAttempts",
"createDate",
"updateDate",
"isAdmin",
"kind",
"email",
"userName",
"name",
"userGroupIds"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"languageIsoCode": {
"type": [
"null",
"string"
]
},
"documentStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasDocumentRootAccess": {
"type": "boolean"
},
"mediaStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasMediaRootAccess": {
"type": "boolean"
},
"elementStartNodeIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
},
"hasElementRootAccess": {
"type": "boolean"
},
"avatarUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"state": {
"$ref": "#/components/schemas/UserStateModel"
},
"failedLoginAttempts": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updateDate": {
"type": "string",
"format": "date-time"
},
"lastLoginDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"lastLockoutDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"lastPasswordChangeDate": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"isAdmin": {
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/UserKindModel"
},
"email": {
"type": "string"
},
"userName": {
"type": "string"
},
"name": {
"type": "string"
},
"userGroupIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceByIdModel"
}
}
}
},
"UserSettingsPresentationModel": {
"required": [
"minCharLength",
"minNonAlphaNumericLength",
"consentLevels"
],
"type": "object",
"properties": {
"minCharLength": {
"type": "integer",
"format": "int32"
},
"minNonAlphaNumericLength": {
"type": "integer",
"format": "int32"
},
"consentLevels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsentLevelPresentationModel"
}
}
}
},
"UserStateModel": {
"enum": [
"Active",
"Disabled",
"LockedOut",
"Invited",
"Inactive",
"All"
]
},
"UserTwoFactorProviderModel": {
"required": [
"providerName",
"isEnabledOnUser"
],
"type": "object",
"properties": {
"providerName": {
"type": "string"
},
"isEnabledOnUser": {
"type": "boolean"
}
}
},
"ValidateUpdateDocumentRequestModel": {
"required": [
"values",
"variants"
],
"type": "object",
"properties": {
"cultures": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
},
"template": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ReferenceByIdModel"
}
]
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentVariantRequestModel"
}
}
}
},
"ValidateUpdateElementRequestModel": {
"required": [
"values",
"variants"
],
"type": "object",
"properties": {
"cultures": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementValueModel"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementVariantRequestModel"
}
}
}
},
"VariantItemResponseModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"culture": {
"type": [
"null",
"string"
]
}
}
},
"VerifyInviteUserRequestModel": {
"required": [
"user",
"token"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"token": {
"type": "string"
}
}
},
"VerifyInviteUserResponseModel": {
"required": [
"passwordConfiguration"
],
"type": "object",
"properties": {
"passwordConfiguration": {
"$ref": "#/components/schemas/PasswordConfigurationResponseModel"
}
}
},
"VerifyResetPasswordResponseModel": {
"required": [
"passwordConfiguration"
],
"type": "object",
"properties": {
"passwordConfiguration": {
"$ref": "#/components/schemas/PasswordConfigurationResponseModel"
}
}
},
"VerifyResetPasswordTokenRequestModel": {
"required": [
"user",
"resetCode"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/ReferenceByIdModel"
},
"resetCode": {
"type": "string"
}
}
},
"WebhookEventModel": {
"required": [
"eventName",
"eventType",
"alias"
],
"type": "object",
"properties": {
"eventName": {
"type": "string"
},
"eventType": {
"type": "string"
},
"alias": {
"type": "string"
}
}
},
"WebhookEventResponseModel": {
"required": [
"eventName",
"eventType",
"alias"
],
"type": "object",
"properties": {
"eventName": {
"type": "string"
},
"eventType": {
"type": "string"
},
"alias": {
"type": "string"
}
}
},
"WebhookItemResponseModel": {
"required": [
"enabled",
"name",
"events",
"url",
"types",
"id",
"flags"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"events": {
"type": "string"
},
"url": {
"type": "string"
},
"types": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"flags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlagModel"
}
}
}
},
"WebhookLogResponseModel": {
"required": [
"key",
"webhookKey",
"statusCode",
"isSuccessStatusCode",
"date",
"eventAlias",
"url",
"retryCount",
"requestHeaders",
"requestBody",
"responseHeaders",
"responseBody",
"exceptionOccured"
],
"type": "object",
"properties": {
"key": {
"type": "string",
"format": "uuid"
},
"webhookKey": {
"type": "string",
"format": "uuid"
},
"statusCode": {
"type": "string"
},
"httpStatusCode": {
"type": [
"null",
"integer"
],
"format": "int32"
},
"isSuccessStatusCode": {
"type": "boolean"
},
"date": {
"type": "string",
"format": "date-time"
},
"eventAlias": {
"type": "string"
},
"url": {
"type": "string"
},
"retryCount": {
"type": "integer",
"format": "int32"
},
"requestHeaders": {
"type": "string"
},
"requestBody": {
"type": "string"
},
"responseHeaders": {
"type": "string"
},
"responseBody": {
"type": "string"
},
"exceptionOccured": {
"type": "boolean"
}
}
},
"WebhookResponseModel": {
"required": [
"url",
"id",
"events",
"enabled",
"contentTypeKeys",
"headers"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookEventResponseModel"
}
},
"enabled": {
"type": "boolean"
},
"name": {
"type": [
"null",
"string"
]
},
"description": {
"type": [
"null",
"string"
]
},
"url": {
"type": "string"
},
"contentTypeKeys": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
},
"securitySchemes": {
"Backoffice-User": {
"type": "oauth2",
"description": "Umbraco Authentication",
"flows": {
"authorizationCode": {
"authorizationUrl": "/umbraco/management/api/v1/security/back-office/authorize",
"tokenUrl": "/umbraco/management/api/v1/security/back-office/token",
"scopes": {}
}
}
}
}
},
"security": [
{
"Backoffice-User": []
}
],
"tags": [
{
"name": "Culture"
},
{
"name": "Data Type"
},
{
"name": "Dictionary"
},
{
"name": "Document"
},
{
"name": "Document Blueprint"
},
{
"name": "Document Type"
},
{
"name": "Document Version"
},
{
"name": "Dynamic Root"
},
{
"name": "Element"
},
{
"name": "Element Version"
},
{
"name": "Health Check"
},
{
"name": "Help"
},
{
"name": "Imaging"
},
{
"name": "Import"
},
{
"name": "Indexer"
},
{
"name": "Install"
},
{
"name": "Language"
},
{
"name": "Log Viewer"
},
{
"name": "Manifest"
},
{
"name": "Media"
},
{
"name": "Media Type"
},
{
"name": "Member"
},
{
"name": "Member Group"
},
{
"name": "Member Type"
},
{
"name": "Models Builder"
},
{
"name": "News Dashboard"
},
{
"name": "Object Types"
},
{
"name": "Package"
},
{
"name": "Partial View"
},
{
"name": "Preview"
},
{
"name": "Profiling"
},
{
"name": "Property Type"
},
{
"name": "Published Cache"
},
{
"name": "Redirect Management"
},
{
"name": "Relation"
},
{
"name": "Relation Type"
},
{
"name": "Script"
},
{
"name": "Searcher"
},
{
"name": "Security"
},
{
"name": "Segment"
},
{
"name": "Server"
},
{
"name": "Static File"
},
{
"name": "Stylesheet"
},
{
"name": "Tag"
},
{
"name": "Telemetry"
},
{
"name": "Template"
},
{
"name": "Temporary File"
},
{
"name": "Upgrade"
},
{
"name": "User"
},
{
"name": "User Data"
},
{
"name": "User Group"
},
{
"name": "Webhook"
},
{
"name": "oEmbed"
}
]
}