yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
dd90ef2d81439924df975259634a0447552206dc
Umbraco-CMS/src/Umbraco.Cms.Api.Management/OpenApi.json
Mole dd90ef2d81 Update OpenApi.json (#14417)
2023-06-20 10:23:41 +02:00

15933 lines
374 KiB
JSON
Raw Blame History

{
"openapi": "3.0.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/audit-log": {
"get": {
"tags": [
"Audit Log"
],
"operationId": "GetAuditLog",
"parameters": [
{
"name": "orderDirection",
"in": "query",
"schema": {
"$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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAuditLogWithUsernameResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/audit-log/{id}": {
"get": {
"tags": [
"Audit Log"
],
"operationId": "GetAuditLogById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "orderDirection",
"in": "query",
"schema": {
"$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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAuditLogResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/audit-log/type/{logType}": {
"get": {
"tags": [
"Audit Log"
],
"operationId": "GetAuditLogTypeByLogType",
"parameters": [
{
"name": "logType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/AuditTypeModel"
}
},
{
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedAuditLogResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/culture": {
"get": {
"tags": [
"Culture"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedCultureReponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/data-type": {
"post": {
"tags": [
"Data Type"
],
"operationId": "PostDataType",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateDataTypeRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/data-type/{id}": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetDataTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/DataTypeResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Data Type"
],
"operationId": "DeleteDataTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Data Type"
],
"operationId": "PutDataTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateDataTypeRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/data-type/{id}/copy": {
"post": {
"tags": [
"Data Type"
],
"operationId": "PostDataTypeByIdCopy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CopyDataTypeRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/data-type/{id}/is-used": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetDataTypeByIdIsUsed",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "boolean"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/data-type/{id}/move": {
"post": {
"tags": [
"Data Type"
],
"operationId": "PostDataTypeByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/MoveDataTypeRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/data-type/{id}/references": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetDataTypeByIdReferences",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DataTypeReferenceResponseModel"
}
]
}
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/data-type/folder": {
"post": {
"tags": [
"Data Type"
],
"operationId": "PostDataTypeFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateFolderRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/data-type/folder/{id}": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetDataTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/FolderReponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Data Type"
],
"operationId": "DeleteDataTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Data Type"
],
"operationId": "PutDataTypeFolderById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateFolderReponseModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/data-type/item": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetDataTypeItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DataTypeItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/data-type/item/{alias}": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetDataTypeItemByAlias",
"parameters": [
{
"name": "alias",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/DataTypeItemResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/data-type/children": {
"get": {
"tags": [
"Data Type"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFolderTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/data-type/root": {
"get": {
"tags": [
"Data Type"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFolderTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/dictionary": {
"get": {
"tags": [
"Dictionary"
],
"operationId": "GetDictionary",
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDictionaryOverviewResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Dictionary"
],
"operationId": "PostDictionary",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateDictionaryItemRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
},
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/dictionary/{id}": {
"get": {
"tags": [
"Dictionary"
],
"operationId": "GetDictionaryById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/DictionaryItemResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Dictionary"
],
"operationId": "DeleteDictionaryById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Dictionary"
],
"operationId": "PutDictionaryById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateDictionaryItemRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/dictionary/{id}/export": {
"get": {
"tags": [
"Dictionary"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/dictionary/{id}/move": {
"post": {
"tags": [
"Dictionary"
],
"operationId": "PostDictionaryByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/MoveDictionaryRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/dictionary/import": {
"post": {
"tags": [
"Dictionary"
],
"operationId": "PostDictionaryImport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ImportDictionaryRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/dictionary/item": {
"get": {
"tags": [
"Dictionary"
],
"operationId": "GetDictionaryItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DictionaryItemItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/dictionary/children": {
"get": {
"tags": [
"Dictionary"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedEntityTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/dictionary/root": {
"get": {
"tags": [
"Dictionary"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedEntityTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/document-blueprint/item": {
"get": {
"tags": [
"Document Blueprint"
],
"operationId": "GetDocumentBlueprintItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentBlueprintResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/document-blueprint/root": {
"get": {
"tags": [
"Document Blueprint"
],
"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
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentBlueprintTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/document-type": {
"post": {
"tags": [
"Document Type"
],
"operationId": "PostDocumentType",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateDocumentTypeRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/document-type/{id}": {
"get": {
"tags": [
"Document Type"
],
"operationId": "GetDocumentTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentTypeResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Document Type"
],
"operationId": "DeleteDocumentTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentTypeResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Document Type"
],
"operationId": "PutDocumentTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateDocumentTypeRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/document-type/item": {
"get": {
"tags": [
"Document Type"
],
"operationId": "GetDocumentTypeItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentTypeItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/document-type/children": {
"get": {
"tags": [
"Document Type"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentTypeTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/document-type/root": {
"get": {
"tags": [
"Document Type"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentTypeTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/document": {
"post": {
"tags": [
"Document"
],
"operationId": "PostDocument",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateDocumentRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/document/{id}": {
"get": {
"tags": [
"Document"
],
"operationId": "GetDocumentById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Document"
],
"operationId": "DeleteDocumentById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Document"
],
"operationId": "PutDocumentById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateDocumentRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/document/{id}/copy": {
"post": {
"tags": [
"Document"
],
"operationId": "PostDocumentByIdCopy",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CopyDocumentRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/document/{id}/domains": {
"get": {
"tags": [
"Document"
],
"operationId": "GetDocumentByIdDomains",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Document"
],
"operationId": "PutDocumentByIdDomains",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateDomainsRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/document/{id}/move": {
"put": {
"tags": [
"Document"
],
"operationId": "PutDocumentByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/MoveDocumentRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/document/{id}/notifications": {
"get": {
"tags": [
"Document"
],
"operationId": "GetDocumentByIdNotifications",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentNotificationResponseModel"
}
]
}
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Document"
],
"operationId": "PutDocumentByIdNotifications",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateDocumentNotificationsRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/document/item": {
"get": {
"tags": [
"Document"
],
"operationId": "GetDocumentItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/document/children": {
"get": {
"tags": [
"Document"
],
"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": {
"401": {
"description": "Unauthorized"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRecycleBinItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/document/root": {
"get": {
"tags": [
"Document"
],
"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": {
"401": {
"description": "Unauthorized"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRecycleBinItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/document/children": {
"get": {
"tags": [
"Document"
],
"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"
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/document/root": {
"get": {
"tags": [
"Document"
],
"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"
}
},
{
"name": "culture",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/health-check-group": {
"get": {
"tags": [
"Health Check"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedHealthCheckGroupResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/health-check-group/{name}": {
"get": {
"tags": [
"Health Check"
],
"operationId": "GetHealthCheckGroupByName",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Not Found"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/HealthCheckGroupPresentationModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/health-check-group/{name}/check": {
"post": {
"tags": [
"Health Check"
],
"operationId": "PostHealthCheckGroupByNameCheck",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Not Found"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/HealthCheckGroupWithResultResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/health-check/execute-action": {
"post": {
"tags": [
"Health Check"
],
"operationId": "PostHealthCheckExecuteAction",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/HealthCheckActionRequestModel"
}
]
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/HealthCheckResultResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/help": {
"get": {
"tags": [
"Help"
],
"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"
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "baseUrl",
"in": "query",
"schema": {
"type": "string",
"default": "https://our.umbraco.com"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedHelpPageResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/indexer": {
"get": {
"tags": [
"Indexer"
],
"operationId": "GetIndexer",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedIndexResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/indexer/{indexName}": {
"get": {
"tags": [
"Indexer"
],
"operationId": "GetIndexerByIndexName",
"parameters": [
{
"name": "indexName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/IndexResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/indexer/{indexName}/rebuild": {
"post": {
"tags": [
"Indexer"
],
"operationId": "PostIndexerByIndexNameRebuild",
"parameters": [
{
"name": "indexName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OkResultModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/install/settings": {
"get": {
"tags": [
"Install"
],
"operationId": "GetInstallSettings",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"428": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/InstallSettingsResponseModel"
}
]
}
}
}
}
}
}
},
"/umbraco/management/api/v1/install/setup": {
"post": {
"tags": [
"Install"
],
"operationId": "PostInstallSetup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/InstallVResponseModel"
}
]
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"428": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success"
}
}
}
},
"/umbraco/management/api/v1/install/validate-database": {
"post": {
"tags": [
"Install"
],
"operationId": "PostInstallValidateDatabase",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/DatabaseInstallResponseModel"
}
]
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success"
}
}
}
},
"/umbraco/management/api/v1/language": {
"get": {
"tags": [
"Language"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedLanguageResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Language"
],
"operationId": "PostLanguage",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateLanguageRequestModel"
}
]
}
}
}
},
"responses": {
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/language/{isoCode}": {
"get": {
"tags": [
"Language"
],
"operationId": "GetLanguageByIsoCode",
"parameters": [
{
"name": "isoCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Not Found"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/LanguageResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Language"
],
"operationId": "DeleteLanguageByIsoCode",
"parameters": [
{
"name": "isoCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Language"
],
"operationId": "PutLanguageByIsoCode",
"parameters": [
{
"name": "isoCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateLanguageRequestModel"
}
]
}
}
}
},
"responses": {
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/language/item": {
"get": {
"tags": [
"Language"
],
"operationId": "GetLanguageItem",
"parameters": [
{
"name": "isoCode",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/LanguageItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/log-viewer/level": {
"get": {
"tags": [
"Log Viewer"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedLoggerResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/log-viewer/level-count": {
"get": {
"tags": [
"Log Viewer"
],
"operationId": "GetLogViewerLevelCount",
"parameters": [
{
"name": "startDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/LogLevelCountsReponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/log-viewer/log": {
"get": {
"tags": [
"Log Viewer"
],
"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": {
"$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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedLogMessageResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/log-viewer/message-template": {
"get": {
"tags": [
"Log Viewer"
],
"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": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedLogTemplateResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/log-viewer/saved-search": {
"get": {
"tags": [
"Log Viewer"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedSavedLogSearchResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Log Viewer"
],
"operationId": "PostLogViewerSavedSearch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SavedLogSearchRequestModel"
}
]
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/log-viewer/saved-search/{name}": {
"get": {
"tags": [
"Log Viewer"
],
"operationId": "GetLogViewerSavedSearchByName",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Not Found"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SavedLogSearchResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Log Viewer"
],
"operationId": "DeleteLogViewerSavedSearchByName",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Not Found"
},
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/log-viewer/validate-logs-size": {
"get": {
"tags": [
"Log Viewer"
],
"operationId": "GetLogViewerValidateLogsSize",
"parameters": [
{
"name": "startDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/media-type/{id}": {
"get": {
"tags": [
"Media Type"
],
"operationId": "GetMediaTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/MediaTypeResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/media-type/item": {
"get": {
"tags": [
"Media Type"
],
"operationId": "GetMediaTypeItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MediaTypeItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/media-type/children": {
"get": {
"tags": [
"Media Type"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFolderTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/media-type/root": {
"get": {
"tags": [
"Media Type"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFolderTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/media": {
"post": {
"tags": [
"Media"
],
"operationId": "PostMedia",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateMediaRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/media/{id}": {
"get": {
"tags": [
"Media"
],
"operationId": "GetMediaById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Media"
],
"operationId": "DeleteMediaById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Media"
],
"operationId": "PutMediaById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateMediaRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/media/{id}/move": {
"put": {
"tags": [
"Media"
],
"operationId": "PutMediaByIdMove",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/MoveMediaRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/media/item": {
"get": {
"tags": [
"Media"
],
"operationId": "GetMediaItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MediaItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/media/children": {
"get": {
"tags": [
"Media"
],
"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": {
"401": {
"description": "Unauthorized"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRecycleBinItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/recycle-bin/media/root": {
"get": {
"tags": [
"Media"
],
"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": {
"401": {
"description": "Unauthorized"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRecycleBinItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/media/children": {
"get": {
"tags": [
"Media"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedContentTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/media/item": {
"get": {
"tags": [
"Media"
],
"operationId": "GetTreeMediaItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "dataTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTreeItemResponseModel"
},
{
"$ref": "#/components/schemas/DocumentTreeItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/media/root": {
"get": {
"tags": [
"Media"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedContentTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/member-group/item": {
"get": {
"tags": [
"Member Group"
],
"operationId": "GetMemberGroupItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MemberGroupItemReponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/member-group/root": {
"get": {
"tags": [
"Member Group"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedEntityTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/member-type/item": {
"get": {
"tags": [
"Member Type"
],
"operationId": "GetMemberTypeItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MemberTypeItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/member-type/root": {
"get": {
"tags": [
"Member Type"
],
"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
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedEntityTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/member/item": {
"get": {
"tags": [
"Member"
],
"operationId": "GetMemberItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MemberItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/models-builder/build": {
"post": {
"tags": [
"Models Builder"
],
"operationId": "PostModelsBuilderBuild",
"responses": {
"200": {
"description": "Success"
},
"428": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/models-builder/dashboard": {
"get": {
"tags": [
"Models Builder"
],
"operationId": "GetModelsBuilderDashboard",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ModelsBuilderResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/models-builder/status": {
"get": {
"tags": [
"Models Builder"
],
"operationId": "GetModelsBuilderStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/OutOfDateStatusResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/object-types": {
"get": {
"tags": [
"Object Types"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedObjectTypeResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/package/{name}/run-migration": {
"post": {
"tags": [
"Package"
],
"operationId": "PostPackageByNameRunMigration",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Not Found"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/package/created": {
"get": {
"tags": [
"Package"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedPackageDefinitionResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Package"
],
"operationId": "PostPackageCreated",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreatePackageRequestModel"
}
]
}
}
}
},
"responses": {
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/package/created/{id}": {
"get": {
"tags": [
"Package"
],
"operationId": "GetPackageCreatedById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"404": {
"description": "Not Found"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/PackageDefinitionResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Package"
],
"operationId": "DeletePackageCreatedById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"404": {
"description": "Not Found"
},
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Package"
],
"operationId": "PutPackageCreatedById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdatePackageRequestModel"
}
]
}
}
}
},
"responses": {
"404": {
"description": "Not Found"
},
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/package/created/{id}/download": {
"get": {
"tags": [
"Package"
],
"operationId": "GetPackageCreatedByIdDownload",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"404": {
"description": "Not Found"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/package/manifest": {
"get": {
"tags": [
"Package"
],
"operationId": "GetPackageManifest",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/PackageManifestResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/package/migration-status": {
"get": {
"tags": [
"Package"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedPackageMigrationStatusResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/partial-view": {
"get": {
"tags": [
"Partial View"
],
"operationId": "GetPartialView",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/PartialViewResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Partial View"
],
"operationId": "PostPartialView",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreatePartialViewRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Partial View"
],
"operationId": "DeletePartialView",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Partial View"
],
"operationId": "PutPartialView",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdatePartialViewRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/partial-view/folder": {
"get": {
"tags": [
"Partial View"
],
"operationId": "GetPartialViewFolder",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Partial View"
],
"operationId": "PostPartialViewFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreatePathFolderRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Partial View"
],
"operationId": "DeletePartialViewFolder",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/partial-view/item": {
"get": {
"tags": [
"Partial View"
],
"operationId": "GetPartialViewItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/PartialViewItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/partial-view/snippet": {
"get": {
"tags": [
"Partial View"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedSnippetItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/partial-view/snippet/{name}": {
"get": {
"tags": [
"Partial View"
],
"operationId": "GetPartialViewSnippetByName",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/PartialViewSnippetResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/partial-view/children": {
"get": {
"tags": [
"Partial View"
],
"operationId": "GetTreePartialViewChildren",
"parameters": [
{
"name": "path",
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/partial-view/root": {
"get": {
"tags": [
"Partial View"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/profiling/status": {
"get": {
"tags": [
"Profiling"
],
"operationId": "GetProfilingStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilingStatusResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Profiling"
],
"operationId": "PutProfilingStatus",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilingStatusRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/property-type/is-used": {
"get": {
"tags": [
"Property Type"
],
"operationId": "GetPropertyTypeIsUsed",
"parameters": [
{
"name": "contentTypeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "propertyAlias",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedBooleanModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/published-cache/collect": {
"post": {
"tags": [
"Published Cache"
],
"operationId": "PostPublishedCacheCollect",
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/published-cache/rebuild": {
"post": {
"tags": [
"Published Cache"
],
"operationId": "PostPublishedCacheRebuild",
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/published-cache/reload": {
"post": {
"tags": [
"Published Cache"
],
"operationId": "PostPublishedCacheReload",
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/published-cache/status": {
"get": {
"tags": [
"Published Cache"
],
"operationId": "GetPublishedCacheStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/redirect-management": {
"get": {
"tags": [
"Redirect Management"
],
"operationId": "GetRedirectManagement",
"parameters": [
{
"name": "filter",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRedirectUrlResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/redirect-management/{id}": {
"get": {
"tags": [
"Redirect Management"
],
"operationId": "GetRedirectManagementById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRedirectUrlResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Redirect Management"
],
"operationId": "DeleteRedirectManagementById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/redirect-management/status": {
"get": {
"tags": [
"Redirect Management"
],
"operationId": "GetRedirectManagementStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/RedirectUrlStatusResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Redirect Management"
],
"operationId": "PostRedirectManagementStatus",
"parameters": [
{
"name": "status",
"in": "query",
"schema": {
"$ref": "#/components/schemas/RedirectStatusModel"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/relation-type": {
"post": {
"tags": [
"Relation Type"
],
"operationId": "PostRelationType",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateRelationTypeRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/relation-type/{id}": {
"get": {
"tags": [
"Relation Type"
],
"operationId": "GetRelationTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/RelationTypeResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Relation Type"
],
"operationId": "DeleteRelationTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Relation Type"
],
"operationId": "PutRelationTypeById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateRelationTypeRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/RelationTypeResponseModel"
}
]
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/relation-type/item": {
"get": {
"tags": [
"Relation Type"
],
"operationId": "GetRelationTypeItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/RelationTypeItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/relation-type/root": {
"get": {
"tags": [
"Relation Type"
],
"operationId": "GetTreeRelationTypeRoot",
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedEntityTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/relation/{id}": {
"get": {
"tags": [
"Relation"
],
"operationId": "GetRelationById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/RelationResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/relation/child-relation/{childId}": {
"get": {
"tags": [
"Relation"
],
"operationId": "GetRelationChildRelationByChildId",
"parameters": [
{
"name": "childId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "relationTypeAlias",
"in": "query",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRelationResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/relation/type/{id}": {
"get": {
"tags": [
"Relation"
],
"operationId": "GetRelationTypeById",
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRelationResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/script": {
"get": {
"tags": [
"Script"
],
"operationId": "GetScript",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ScriptResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Script"
],
"operationId": "PostScript",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateScriptRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Script"
],
"operationId": "DeleteScript",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Script"
],
"operationId": "PutScript",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateScriptRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/script/folder": {
"get": {
"tags": [
"Script"
],
"operationId": "GetScriptFolder",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Script"
],
"operationId": "PostScriptFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreatePathFolderRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Script"
],
"operationId": "DeleteScriptFolder",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/script/item": {
"get": {
"tags": [
"Script"
],
"operationId": "GetScriptItem",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ScriptItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/script/children": {
"get": {
"tags": [
"Script"
],
"operationId": "GetTreeScriptChildren",
"parameters": [
{
"name": "path",
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/script/root": {
"get": {
"tags": [
"Script"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/searcher": {
"get": {
"tags": [
"Searcher"
],
"operationId": "GetSearcher",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedSearcherResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/searcher/{searcherName}/query": {
"get": {
"tags": [
"Searcher"
],
"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"
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedSearchResultResponseModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/security/back-office/authorize": {
"get": {
"tags": [
"Security"
],
"operationId": "GetSecurityBackOfficeAuthorize",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/umbraco/management/api/v1/security/back-office/login": {
"post": {
"tags": [
"Security"
],
"operationId": "PostSecurityBackOfficeLogin",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/LoginRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/umbraco/management/api/v1/server/status": {
"get": {
"tags": [
"Server"
],
"operationId": "GetServerStatus",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ServerStatusResponseModel"
}
]
}
}
}
}
}
}
},
"/umbraco/management/api/v1/server/version": {
"get": {
"tags": [
"Server"
],
"operationId": "GetServerVersion",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/VersionResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/static-file/item": {
"get": {
"tags": [
"Static File"
],
"operationId": "GetStaticFileItem",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticFileItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/static-file/children": {
"get": {
"tags": [
"Static File"
],
"operationId": "GetTreeStaticFileChildren",
"parameters": [
{
"name": "path",
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/static-file/root": {
"get": {
"tags": [
"Static File"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/stylesheet": {
"get": {
"tags": [
"Stylesheet"
],
"operationId": "GetStylesheet",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/StylesheetResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Stylesheet"
],
"operationId": "PostStylesheet",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateStylesheetRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Stylesheet"
],
"operationId": "DeleteStylesheet",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Stylesheet"
],
"operationId": "PutStylesheet",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateStylesheetRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/stylesheet/all": {
"get": {
"tags": [
"Stylesheet"
],
"operationId": "GetStylesheetAll",
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedStylesheetOverviewResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/stylesheet/folder": {
"get": {
"tags": [
"Stylesheet"
],
"operationId": "GetStylesheetFolder",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Stylesheet"
],
"operationId": "PostStylesheetFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreatePathFolderRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Stylesheet"
],
"operationId": "DeleteStylesheetFolder",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/stylesheet/item": {
"get": {
"tags": [
"Stylesheet"
],
"operationId": "GetStylesheetItem",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ScriptItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/stylesheet/rich-text/extract-rules": {
"post": {
"tags": [
"Stylesheet"
],
"operationId": "PostStylesheetRichTextExtractRules",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ExtractRichTextStylesheetRulesRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ExtractRichTextStylesheetRulesResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/stylesheet/rich-text/interpolate-rules": {
"post": {
"tags": [
"Stylesheet"
],
"operationId": "PostStylesheetRichTextInterpolateRules",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/InterpolateRichTextStylesheetRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/InterpolateRichTextStylesheetResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/stylesheet/rich-text/rules": {
"get": {
"tags": [
"Stylesheet"
],
"operationId": "GetStylesheetRichTextRules",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/RichTextStylesheetRulesResponseModel"
},
{
"$ref": "#/components/schemas/ExtractRichTextStylesheetRulesResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/stylesheet/children": {
"get": {
"tags": [
"Stylesheet"
],
"operationId": "GetTreeStylesheetChildren",
"parameters": [
{
"name": "path",
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/stylesheet/root": {
"get": {
"tags": [
"Stylesheet"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tag": {
"get": {
"tags": [
"Tag"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedTagResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/telemetry": {
"get": {
"tags": [
"Telemetry"
],
"operationId": "GetTelemetry",
"parameters": [
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedTelemetryResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/telemetry/level": {
"get": {
"tags": [
"Telemetry"
],
"operationId": "GetTelemetryLevel",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/TelemetryResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Telemetry"
],
"operationId": "PostTelemetryLevel",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/TelemetryRequestModel"
}
]
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/template": {
"post": {
"tags": [
"Template"
],
"operationId": "PostTemplate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateTemplateRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/template/{id}": {
"get": {
"tags": [
"Template"
],
"operationId": "GetTemplateById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Template"
],
"operationId": "DeleteTemplateById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"Template"
],
"operationId": "PutTemplateById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateTemplateRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/template/item": {
"get": {
"tags": [
"Template"
],
"operationId": "GetTemplateItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/template/query/execute": {
"post": {
"tags": [
"Template"
],
"operationId": "PostTemplateQueryExecute",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateQueryExecuteModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateQueryResultResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/template/query/settings": {
"get": {
"tags": [
"Template"
],
"operationId": "GetTemplateQuerySettings",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateQuerySettingsResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/template/scaffold": {
"get": {
"tags": [
"Template"
],
"operationId": "GetTemplateScaffold",
"parameters": [
{
"name": "masterTemplateId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateScaffoldResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/template/children": {
"get": {
"tags": [
"Template"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedEntityTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tree/template/root": {
"get": {
"tags": [
"Template"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedEntityTreeItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/temporaryfile": {
"post": {
"tags": [
"Temporary File"
],
"operationId": "PostTemporaryfile",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"format": "uuid"
},
"File": {
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"Id": {
"style": "form"
},
"File": {
"style": "form"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/temporaryfile/{id}": {
"get": {
"tags": [
"Temporary File"
],
"operationId": "GetTemporaryfileById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/TemporaryFileResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"Temporary File"
],
"operationId": "DeleteTemporaryfileById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tour": {
"get": {
"tags": [
"Tour"
],
"operationId": "GetTour",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UserTourStatusesResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"Tour"
],
"operationId": "PostTour",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SetTourStatusRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tracked-reference/{id}": {
"get": {
"tags": [
"Tracked Reference"
],
"operationId": "GetTrackedReferenceById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int64",
"default": 20
}
},
{
"name": "filterMustBeIsDependency",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRelationItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tracked-reference/descendants/{parentId}": {
"get": {
"tags": [
"Tracked Reference"
],
"operationId": "GetTrackedReferenceDescendantsByParentId",
"parameters": [
{
"name": "parentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "filterMustBeIsDependency",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRelationItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/tracked-reference/item": {
"get": {
"tags": [
"Tracked Reference"
],
"operationId": "GetTrackedReferenceItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int64",
"default": 20
}
},
{
"name": "filterMustBeIsDependency",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRelationItemResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/upgrade/authorize": {
"post": {
"tags": [
"Upgrade"
],
"operationId": "PostUpgradeAuthorize",
"responses": {
"200": {
"description": "Success"
},
"428": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/upgrade/settings": {
"get": {
"tags": [
"Upgrade"
],
"operationId": "GetUpgradeSettings",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpgradeSettingsResponseModel"
}
]
}
}
}
},
"428": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user-group": {
"post": {
"tags": [
"User Group"
],
"operationId": "PostUserGroup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateUserGroupRequestModel"
}
]
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"get": {
"tags": [
"User Group"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedUserGroupResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user-group/{id}": {
"get": {
"tags": [
"User Group"
],
"operationId": "GetUserGroupById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UserGroupResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"User Group"
],
"operationId": "DeleteUserGroupById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"User Group"
],
"operationId": "PutUserGroupById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateUserGroupRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user-group/item": {
"get": {
"tags": [
"User Group"
],
"operationId": "GetUserGroupItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserGroupItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user": {
"post": {
"tags": [
"User"
],
"operationId": "PostUser",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateUserRequestModel"
},
{
"$ref": "#/components/schemas/InviteUserRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateUserResponseModel"
}
]
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"get": {
"tags": [
"User"
],
"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": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedUserResponseModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/{id}": {
"get": {
"tags": [
"User"
],
"operationId": "GetUserById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UserResponseModel"
}
]
}
}
}
},
"404": {
"description": "Not Found"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"delete": {
"tags": [
"User"
],
"operationId": "DeleteUserById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"put": {
"tags": [
"User"
],
"operationId": "PutUserById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateUserRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/avatar/{id}": {
"delete": {
"tags": [
"User"
],
"operationId": "DeleteUserAvatarById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
},
"post": {
"tags": [
"User"
],
"operationId": "PostUserAvatarById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SetAvatarRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/change-password/{id}": {
"post": {
"tags": [
"User"
],
"operationId": "PostUserChangePasswordById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ChangePasswordUserRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/current": {
"get": {
"tags": [
"User"
],
"operationId": "GetUserCurrent",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/CurrentUserResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/current/avatar": {
"post": {
"tags": [
"User"
],
"operationId": "PostUserCurrentAvatar",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SetAvatarRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/current/change-password": {
"post": {
"tags": [
"User"
],
"operationId": "PostUserCurrentChangePassword",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ChangePasswordUserRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/current/data": {
"get": {
"tags": [
"User"
],
"operationId": "GetUserCurrentData",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UserDataResponseModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/current/logins": {
"get": {
"tags": [
"User"
],
"operationId": "GetUserCurrentLogins",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/LinkedLoginsRequestModel"
}
]
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/current/permissions": {
"get": {
"tags": [
"User"
],
"operationId": "GetUserCurrentPermissions",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserPermissionsResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/current/permissions/document": {
"get": {
"tags": [
"User"
],
"operationId": "GetUserCurrentPermissionsDocument",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserPermissionsResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/current/permissions/media": {
"get": {
"tags": [
"User"
],
"operationId": "GetUserCurrentPermissionsMedia",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserPermissionsResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/disable": {
"post": {
"tags": [
"User"
],
"operationId": "PostUserDisable",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/DisableUserRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/enable": {
"post": {
"tags": [
"User"
],
"operationId": "PostUserEnable",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/EnableUserRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/filter": {
"get": {
"tags": [
"User"
],
"operationId": "GetUserFilter",
"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": {
"$ref": "#/components/schemas/UserOrderModel"
}
},
{
"name": "orderDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/DirectionModel"
}
},
{
"name": "userGroupIds",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "userStates",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserStateModel"
}
}
},
{
"name": "filter",
"in": "query",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/invite": {
"post": {
"tags": [
"User"
],
"operationId": "PostUserInvite",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/InviteUserRequestModel"
}
]
}
}
}
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Location": {
"description": "Location of the newly created resource",
"schema": {
"type": "string",
"description": "Location of the newly created resource",
"format": "uri"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/item": {
"get": {
"tags": [
"User"
],
"operationId": "GetUserItem",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserItemResponseModel"
}
]
}
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/set-user-groups": {
"post": {
"tags": [
"User"
],
"operationId": "PostUserSetUserGroups",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateUserGroupsOnUserRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
},
"/umbraco/management/api/v1/user/unlock": {
"post": {
"tags": [
"User"
],
"operationId": "PostUserUnlock",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/UnlockUsersRequestModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
},
"security": [
{
"Backoffice User": [ ]
}
]
}
}
},
"components": {
"schemas": {
"AuditLogBaseModel": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"format": "uuid"
},
"entityId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"logType": {
"$ref": "#/components/schemas/AuditTypeModel"
},
"entityType": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"parameters": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AuditLogResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditLogBaseModel"
}
],
"additionalProperties": false
},
"AuditLogWithUsernameResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditLogBaseModel"
}
],
"properties": {
"userName": {
"type": "string",
"nullable": true
},
"userAvatars": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"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"
],
"type": "integer",
"format": "int32"
},
"ChangePasswordUserRequestModel": {
"type": "object",
"properties": {
"newPassword": {
"type": "string"
},
"oldPassword": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ConsentLevelPresentationModel": {
"type": "object",
"properties": {
"level": {
"$ref": "#/components/schemas/TelemetryLevelModel"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
},
"ContentResponseModelBaseDocumentValueModelDocumentVariantResponseModel": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentValueModel"
}
]
}
},
"variants": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentVariantResponseModel"
}
]
}
},
"id": {
"type": "string",
"format": "uuid"
},
"contentTypeId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"ContentStateModel": {
"enum": [
"NotCreated",
"Draft",
"Published",
"PublishedPendingChanges"
],
"type": "integer",
"format": "int32"
},
"ContentTreeItemResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/EntityTreeItemResponseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"noAccess": {
"type": "boolean"
},
"isTrashed": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"ContentTreeItemResponseModel": "#/components/schemas/ContentTreeItemResponseModel",
"DocumentTreeItemResponseModel": "#/components/schemas/DocumentTreeItemResponseModel"
}
}
},
"ContentTypeCleanupModel": {
"type": "object",
"properties": {
"preventCleanup": {
"type": "boolean"
},
"keepAllVersionsNewerThanDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"keepLatestVersionPerDayForDays": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"ContentTypeCompositionModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"compositionType": {
"$ref": "#/components/schemas/ContentTypeCompositionTypeModel"
}
},
"additionalProperties": false
},
"ContentTypeCompositionTypeModel": {
"enum": [
"Composition",
"Inheritance"
],
"type": "integer",
"format": "int32"
},
"ContentTypeResponseModelBaseDocumentTypePropertyTypeResponseModelDocumentTypePropertyTypeContainerResponseModel": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"isElement": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentTypePropertyTypeResponseModel"
}
]
}
},
"containers": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentTypePropertyTypeContainerResponseModel"
}
]
}
},
"allowedContentTypes": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTypeSortModel"
}
]
}
},
"compositions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTypeCompositionModel"
}
]
}
},
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"ContentTypeResponseModelBaseMediaTypePropertyTypeResponseModelMediaTypePropertyTypeContainerResponseModel": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"isElement": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MediaTypePropertyTypeResponseModel"
}
]
}
},
"containers": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MediaTypePropertyTypeContainerResponseModel"
}
]
}
},
"allowedContentTypes": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTypeSortModel"
}
]
}
},
"compositions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTypeCompositionModel"
}
]
}
},
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"ContentTypeSortModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ContentUrlInfoModel": {
"type": "object",
"properties": {
"culture": {
"type": "string",
"nullable": true
},
"url": {
"type": "string"
}
},
"additionalProperties": false
},
"CopyDataTypeRequestModel": {
"type": "object",
"properties": {
"targetId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"CopyDocumentRequestModel": {
"type": "object",
"properties": {
"targetId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"relateToOriginal": {
"type": "boolean"
},
"includeDescendants": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CreateContentRequestModelBaseDocumentValueModelDocumentVariantRequestModel": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentValueModel"
}
]
}
},
"variants": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentVariantRequestModel"
}
]
}
},
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"CreateContentRequestModelBaseMediaValueModelMediaVariantRequestModel": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MediaValueModel"
}
]
}
},
"variants": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MediaVariantRequestModel"
}
]
}
},
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"CreateContentTypeRequestModelBaseCreateDocumentTypePropertyTypeRequestModelCreateDocumentTypePropertyTypeContainerRequestModel": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"isElement": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateDocumentTypePropertyTypeRequestModel"
}
]
}
},
"containers": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/CreateDocumentTypePropertyTypeContainerRequestModel"
}
]
}
},
"allowedContentTypes": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTypeSortModel"
}
]
}
},
"compositions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTypeCompositionModel"
}
]
}
}
},
"additionalProperties": false
},
"CreateDataTypeRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/DataTypeModelBaseModel"
}
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"CreateDictionaryItemRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/DictionaryItemModelBaseModel"
}
],
"properties": {
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"CreateDocumentRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CreateContentRequestModelBaseDocumentValueModelDocumentVariantRequestModel"
}
],
"properties": {
"contentTypeId": {
"type": "string",
"format": "uuid"
},
"templateId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"CreateDocumentTypePropertyTypeContainerRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PropertyTypeContainerModelBaseModel"
}
],
"additionalProperties": false
},
"CreateDocumentTypePropertyTypeRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PropertyTypeModelBaseModel"
}
],
"additionalProperties": false
},
"CreateDocumentTypeRequestModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CreateContentTypeRequestModelBaseCreateDocumentTypePropertyTypeRequestModelCreateDocumentTypePropertyTypeContainerRequestModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"allowedTemplateIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"defaultTemplateId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"cleanup": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTypeCleanupModel"
}
]
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"CreateDocumentTypeRequestModel": "#/components/schemas/CreateDocumentTypeRequestModel"
}
}
},
"CreateFolderRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FolderModelBaseModel"
}
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"CreateLanguageRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/LanguageModelBaseModel"
}
],
"properties": {
"isoCode": {
"type": "string"
}
},
"additionalProperties": false
},
"CreateMediaRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CreateContentRequestModelBaseMediaValueModelMediaVariantRequestModel"
}
],
"properties": {
"contentTypeId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"CreatePackageRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PackageModelBaseModel"
}
],
"additionalProperties": false
},
"CreatePartialViewRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CreateTextFileViewModelBaseModel"
}
],
"additionalProperties": false
},
"CreatePathFolderRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PathFolderModelBaseModel"
}
],
"properties": {
"parentPath": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CreateRelationTypeRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/RelationTypeBaseModel"
}
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"CreateScriptRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CreateTextFileViewModelBaseModel"
}
],
"additionalProperties": false
},
"CreateStylesheetRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CreateTextFileViewModelBaseModel"
}
],
"additionalProperties": false
},
"CreateTemplateRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TemplateModelBaseModel"
}
],
"additionalProperties": false
},
"CreateTextFileViewModelBaseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TextFileViewModelBaseModel"
}
],
"properties": {
"parentPath": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CreateUserGroupRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/UserGroupBaseModel"
}
],
"additionalProperties": false
},
"CreateUserRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/UserPresentationBaseModel"
}
],
"additionalProperties": false
},
"CreateUserResponseModel": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"format": "uuid"
},
"initialPassword": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CultureReponseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"englishName": {
"type": "string"
}
},
"additionalProperties": false
},
"CurrentUserResponseModel": {
"required": [
"$type"
],
"type": "object",
"properties": {
"$type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"email": {
"type": "string"
},
"userName": {
"type": "string"
},
"name": {
"type": "string"
},
"languageIsoCode": {
"type": "string",
"nullable": true
},
"contentStartNodeIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"mediaStartNodeIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"avatarUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"hasAccessToAllLanguages": {
"type": "boolean"
},
"permissions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"CurrentUserResponseModel": "#/components/schemas/CurrentUserResponseModel"
}
}
},
"DataTypeItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"properties": {
"icon": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DataTypeModelBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"propertyEditorAlias": {
"type": "string"
},
"propertyEditorUiAlias": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DataTypePropertyPresentationModel"
}
]
}
}
},
"additionalProperties": false
},
"DataTypePropertyPresentationModel": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"value": {
"nullable": true
}
},
"additionalProperties": false
},
"DataTypePropertyReferenceModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"alias": {
"type": "string"
}
},
"additionalProperties": false
},
"DataTypeReferenceResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"properties": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DataTypePropertyReferenceModel"
}
]
}
}
},
"additionalProperties": false
},
"DataTypeResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/DataTypeModelBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"DataTypeResponseModel": "#/components/schemas/DataTypeResponseModel"
}
}
},
"DatabaseInstallResponseModel": {
"required": [
"id",
"providerName"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"providerName": {
"minLength": 1,
"type": "string"
},
"server": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"useIntegratedAuthentication": {
"type": "boolean"
},
"connectionString": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DatabaseSettingsPresentationModel": {
"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"
},
"requiresConnectionTest": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DictionaryItemItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"additionalProperties": false
},
"DictionaryItemModelBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"translations": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DictionaryItemTranslationModel"
}
]
}
}
},
"additionalProperties": false
},
"DictionaryItemResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/DictionaryItemModelBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"DictionaryItemResponseModel": "#/components/schemas/DictionaryItemResponseModel"
}
}
},
"DictionaryItemTranslationModel": {
"type": "object",
"properties": {
"isoCode": {
"type": "string"
},
"translation": {
"type": "string"
}
},
"additionalProperties": false
},
"DictionaryOverviewResponseModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"translatedIsoCodes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"DirectionModel": {
"enum": [
"Ascending",
"Descending"
],
"type": "integer",
"format": "int32"
},
"DisableUserRequestModel": {
"type": "object",
"properties": {
"userIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"additionalProperties": false
},
"DocumentBlueprintResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"additionalProperties": false
},
"DocumentBlueprintTreeItemResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/EntityTreeItemResponseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"documentTypeId": {
"type": "string",
"format": "uuid"
},
"documentTypeAlias": {
"type": "string"
},
"documentTypeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"DocumentBlueprintTreeItemResponseModel": "#/components/schemas/DocumentBlueprintTreeItemResponseModel"
}
}
},
"DocumentItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"properties": {
"icon": {
"type": "string",
"nullable": true
},
"contentTypeId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"DocumentNotificationResponseModel": {
"type": "object",
"properties": {
"actionId": {
"type": "string"
},
"subscribed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DocumentResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ContentResponseModelBaseDocumentValueModelDocumentVariantResponseModel"
}
],
"properties": {
"urls": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentUrlInfoModel"
}
]
}
},
"templateId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"DocumentTreeItemResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ContentTreeItemResponseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"isProtected": {
"type": "boolean"
},
"isPublished": {
"type": "boolean"
},
"isEdited": {
"type": "boolean"
},
"contentTypeId": {
"type": "string",
"format": "uuid"
},
"variants": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/VariantTreeItemModel"
}
]
}
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"DocumentTreeItemResponseModel": "#/components/schemas/DocumentTreeItemResponseModel"
}
}
},
"DocumentTypeItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"properties": {
"isElement": {
"type": "boolean"
},
"icon": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DocumentTypePropertyTypeContainerResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PropertyTypeContainerModelBaseModel"
}
],
"additionalProperties": false
},
"DocumentTypePropertyTypeResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PropertyTypeModelBaseModel"
}
],
"additionalProperties": false
},
"DocumentTypeResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ContentTypeResponseModelBaseDocumentTypePropertyTypeResponseModelDocumentTypePropertyTypeContainerResponseModel"
}
],
"properties": {
"allowedTemplateIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"defaultTemplateId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"cleanup": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTypeCleanupModel"
}
]
}
},
"additionalProperties": false
},
"DocumentTypeTreeItemResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FolderTreeItemResponseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"isElement": {
"type": "boolean"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"DocumentTypeTreeItemResponseModel": "#/components/schemas/DocumentTypeTreeItemResponseModel"
}
}
},
"DocumentValueModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ValueModelBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"DocumentValueModel": "#/components/schemas/DocumentValueModel"
}
}
},
"DocumentVariantRequestModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/VariantModelBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"DocumentVariantRequestModel": "#/components/schemas/DocumentVariantRequestModel"
}
}
},
"DocumentVariantResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/VariantResponseModelBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"state": {
"$ref": "#/components/schemas/ContentStateModel"
},
"publishDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"DocumentVariantResponseModel": "#/components/schemas/DocumentVariantResponseModel"
}
}
},
"DomainPresentationModel": {
"type": "object",
"properties": {
"domainName": {
"type": "string"
},
"isoCode": {
"type": "string"
}
},
"additionalProperties": false
},
"DomainsPresentationModelBaseModel": {
"type": "object",
"properties": {
"defaultIsoCode": {
"type": "string",
"nullable": true
},
"domains": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DomainPresentationModel"
}
]
}
}
},
"additionalProperties": false
},
"DomainsResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/DomainsPresentationModelBaseModel"
}
],
"additionalProperties": false
},
"EnableUserRequestModel": {
"type": "object",
"properties": {
"userIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"additionalProperties": false
},
"EntityTreeItemResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TreeItemPresentationModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"isContainer": {
"type": "boolean"
},
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"EntityTreeItemResponseModel": "#/components/schemas/EntityTreeItemResponseModel",
"ContentTreeItemResponseModel": "#/components/schemas/ContentTreeItemResponseModel",
"DocumentBlueprintTreeItemResponseModel": "#/components/schemas/DocumentBlueprintTreeItemResponseModel",
"DocumentTreeItemResponseModel": "#/components/schemas/DocumentTreeItemResponseModel",
"DocumentTypeTreeItemResponseModel": "#/components/schemas/DocumentTypeTreeItemResponseModel",
"FolderTreeItemResponseModel": "#/components/schemas/FolderTreeItemResponseModel"
}
}
},
"ExtractRichTextStylesheetRulesRequestModel": {
"type": "object",
"properties": {
"content": {
"type": "string"
}
},
"additionalProperties": false
},
"ExtractRichTextStylesheetRulesResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/RichTextStylesheetRulesResponseModel"
}
],
"additionalProperties": false
},
"FieldPresentationModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"FileItemResponseModelBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"icon": {
"type": "string"
}
},
"additionalProperties": false
},
"FileSystemTreeItemPresentationModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TreeItemPresentationModel"
}
],
"properties": {
"path": {
"type": "string"
},
"isFolder": {
"type": "boolean"
}
},
"additionalProperties": false
},
"FolderModelBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"FolderReponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FolderModelBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"FolderReponseModel": "#/components/schemas/FolderReponseModel"
}
}
},
"FolderTreeItemResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/EntityTreeItemResponseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"isFolder": {
"type": "boolean"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"FolderTreeItemResponseModel": "#/components/schemas/FolderTreeItemResponseModel",
"DocumentTypeTreeItemResponseModel": "#/components/schemas/DocumentTypeTreeItemResponseModel"
}
}
},
"HealthCheckActionRequestModel": {
"type": "object",
"properties": {
"healthCheckId": {
"type": "string",
"format": "uuid"
},
"alias": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"valueRequired": {
"type": "boolean"
},
"providedValue": {
"type": "string",
"nullable": true
},
"providedValueValidation": {
"type": "string",
"nullable": true
},
"providedValueValidationRegex": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"HealthCheckGroupPresentationBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"HealthCheckGroupPresentationModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/HealthCheckGroupPresentationBaseModel"
}
],
"properties": {
"checks": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HealthCheckModel"
}
]
}
}
},
"additionalProperties": false
},
"HealthCheckGroupResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/HealthCheckGroupPresentationBaseModel"
}
],
"additionalProperties": false
},
"HealthCheckGroupWithResultResponseModel": {
"type": "object",
"properties": {
"checks": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HealthCheckWithResultPresentationModel"
}
]
}
}
},
"additionalProperties": false
},
"HealthCheckModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/HealthCheckModelBaseModel"
}
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"HealthCheckModelBaseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"HealthCheckResultResponseModel": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"resultType": {
"$ref": "#/components/schemas/StatusResultTypeModel"
},
"actions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HealthCheckActionRequestModel"
}
]
},
"nullable": true
},
"readMoreLink": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"HealthCheckWithResultPresentationModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/HealthCheckModelBaseModel"
}
],
"properties": {
"results": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HealthCheckResultResponseModel"
}
]
},
"nullable": true
}
},
"additionalProperties": false
},
"HealthStatusModel": {
"enum": [
"Healthy",
"Unhealthy",
"Rebuilding"
],
"type": "integer",
"format": "int32"
},
"HelpPageResponseModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ImportDictionaryRequestModel": {
"type": "object",
"properties": {
"temporaryFileId": {
"type": "string",
"format": "uuid"
},
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"IndexResponseModel": {
"required": [
"canRebuild",
"documentCount",
"fieldCount",
"name"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"healthStatus": {
"$ref": "#/components/schemas/HealthStatusModel"
},
"canRebuild": {
"type": "boolean"
},
"searcherName": {
"type": "string"
},
"documentCount": {
"type": "integer",
"format": "int64"
},
"fieldCount": {
"type": "integer",
"format": "int32"
},
"providerProperties": {
"type": "object",
"additionalProperties": { },
"nullable": true
}
},
"additionalProperties": false
},
"InstallSettingsResponseModel": {
"type": "object",
"properties": {
"user": {
"oneOf": [
{
"$ref": "#/components/schemas/UserSettingsModel"
}
]
},
"databases": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DatabaseSettingsPresentationModel"
}
]
}
}
},
"additionalProperties": false
},
"InstallVResponseModel": {
"required": [
"database",
"user"
],
"type": "object",
"properties": {
"user": {
"oneOf": [
{
"$ref": "#/components/schemas/UserInstallResponseModel"
}
]
},
"database": {
"oneOf": [
{
"$ref": "#/components/schemas/DatabaseInstallResponseModel"
}
]
},
"telemetryLevel": {
"$ref": "#/components/schemas/TelemetryLevelModel"
}
},
"additionalProperties": false
},
"InterpolateRichTextStylesheetRequestModel": {
"type": "object",
"properties": {
"content": {
"type": "string",
"nullable": true
},
"rules": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/RichTextRuleModel"
}
]
},
"nullable": true
}
},
"additionalProperties": false
},
"InterpolateRichTextStylesheetResponseModel": {
"type": "object",
"properties": {
"content": {
"type": "string"
}
},
"additionalProperties": false
},
"InviteUserRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CreateUserRequestModel"
}
],
"properties": {
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ItemResponseModelBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"LanguageItemResponseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"isoCode": {
"type": "string"
}
},
"additionalProperties": false
},
"LanguageModelBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"isMandatory": {
"type": "boolean"
},
"fallbackIsoCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LanguageResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/LanguageModelBaseModel"
}
],
"properties": {
"isoCode": {
"type": "string"
}
},
"additionalProperties": false
},
"LinkedLoginModel": {
"type": "object",
"properties": {
"providerName": {
"type": "string"
},
"providerKey": {
"type": "string"
}
},
"additionalProperties": false
},
"LinkedLoginsRequestModel": {
"type": "object",
"properties": {
"linkedLogins": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/LinkedLoginModel"
}
]
}
}
},
"additionalProperties": false
},
"LogLevelCountsReponseModel": {
"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"
}
},
"additionalProperties": false
},
"LogLevelModel": {
"enum": [
"Verbose",
"Debug",
"Information",
"Warning",
"Error",
"Fatal"
],
"type": "integer",
"format": "int32"
},
"LogMessagePropertyPresentationModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LogMessageResponseModel": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"level": {
"$ref": "#/components/schemas/LogLevelModel"
},
"messageTemplate": {
"type": "string",
"nullable": true
},
"renderedMessage": {
"type": "string",
"nullable": true
},
"properties": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/LogMessagePropertyPresentationModel"
}
]
}
},
"exception": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LogTemplateResponseModel": {
"type": "object",
"properties": {
"messageTemplate": {
"type": "string",
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"LoggerResponseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"level": {
"$ref": "#/components/schemas/LogLevelModel"
}
},
"additionalProperties": false
},
"LoginRequestModel": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"additionalProperties": false
},
"MediaItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"properties": {
"icon": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MediaTypeItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"properties": {
"icon": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MediaTypePropertyTypeContainerResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PropertyTypeContainerModelBaseModel"
}
],
"additionalProperties": false
},
"MediaTypePropertyTypeResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PropertyTypeModelBaseModel"
}
],
"additionalProperties": false
},
"MediaTypeResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ContentTypeResponseModelBaseMediaTypePropertyTypeResponseModelMediaTypePropertyTypeContainerResponseModel"
}
],
"additionalProperties": false
},
"MediaValueModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ValueModelBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"MediaValueModel": "#/components/schemas/MediaValueModel"
}
}
},
"MediaVariantRequestModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/VariantModelBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"MediaVariantRequestModel": "#/components/schemas/MediaVariantRequestModel"
}
}
},
"MediaVariantResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/VariantResponseModelBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"MediaVariantResponseModel": "#/components/schemas/MediaVariantResponseModel"
}
}
},
"MemberGroupItemReponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"additionalProperties": false
},
"MemberItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"properties": {
"icon": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MemberTypeItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"properties": {
"icon": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ModelsBuilderResponseModel": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/ModelsModeModel"
},
"canGenerate": {
"type": "boolean"
},
"outOfDateModels": {
"type": "boolean"
},
"lastError": {
"type": "string",
"nullable": true
},
"version": {
"type": "string",
"nullable": true
},
"modelsNamespace": {
"type": "string",
"nullable": true
},
"trackingOutOfDateModels": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ModelsModeModel": {
"enum": [
"Nothing",
"InMemoryAuto",
"SourceCodeManual",
"SourceCodeAuto"
],
"type": "integer",
"format": "int32"
},
"MoveDataTypeRequestModel": {
"type": "object",
"properties": {
"targetId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"MoveDictionaryRequestModel": {
"type": "object",
"properties": {
"targetId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"MoveDocumentRequestModel": {
"type": "object",
"properties": {
"targetId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"MoveMediaRequestModel": {
"type": "object",
"properties": {
"targetId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"ObjectTypeResponseModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"OkResultModel": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"OperatorModel": {
"enum": [
"Equals",
"NotEquals",
"Contains",
"NotContains",
"LessThan",
"LessThanEqualTo",
"GreaterThan",
"GreaterThanEqualTo"
],
"type": "integer",
"format": "int32"
},
"OutOfDateStatusResponseModel": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/OutOfDateTypeModel"
}
},
"additionalProperties": false
},
"OutOfDateTypeModel": {
"enum": [
"OutOfDate",
"Current",
"Unknown"
],
"type": "integer",
"format": "int32"
},
"PackageDefinitionResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PackageModelBaseModel"
}
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"packagePath": {
"type": "string"
}
},
"additionalProperties": false
},
"PackageManifestResponseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string",
"nullable": true
},
"extensions": {
"type": "array",
"items": { }
}
},
"additionalProperties": false
},
"PackageMigrationStatusResponseModel": {
"type": "object",
"properties": {
"packageName": {
"type": "string"
},
"hasPendingMigrations": {
"type": "boolean"
}
},
"additionalProperties": false
},
"PackageModelBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"contentNodeId": {
"type": "string",
"nullable": true
},
"contentLoadChildNodes": {
"type": "boolean"
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"mediaLoadChildNodes": {
"type": "boolean"
},
"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"
}
}
},
"additionalProperties": false
},
"PagedAuditLogResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AuditLogResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedAuditLogWithUsernameResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AuditLogWithUsernameResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedBooleanModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"type": "boolean"
}
}
},
"additionalProperties": false
},
"PagedContentTreeItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTreeItemResponseModel"
},
{
"$ref": "#/components/schemas/DocumentTreeItemResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedCultureReponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/CultureReponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedDictionaryOverviewResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DictionaryOverviewResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedDocumentBlueprintTreeItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentBlueprintTreeItemResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedDocumentTreeItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentTreeItemResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedDocumentTypeTreeItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentTypeTreeItemResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedEntityTreeItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/EntityTreeItemResponseModel"
},
{
"$ref": "#/components/schemas/ContentTreeItemResponseModel"
},
{
"$ref": "#/components/schemas/DocumentBlueprintTreeItemResponseModel"
},
{
"$ref": "#/components/schemas/DocumentTreeItemResponseModel"
},
{
"$ref": "#/components/schemas/DocumentTypeTreeItemResponseModel"
},
{
"$ref": "#/components/schemas/FolderTreeItemResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedFileSystemTreeItemPresentationModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedFolderTreeItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/FolderTreeItemResponseModel"
},
{
"$ref": "#/components/schemas/DocumentTypeTreeItemResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedHealthCheckGroupResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HealthCheckGroupResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedHelpPageResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HelpPageResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedIndexResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/IndexResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedLanguageResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/LanguageResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedLogMessageResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/LogMessageResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedLogTemplateResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/LogTemplateResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedLoggerResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/LoggerResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedObjectTypeResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ObjectTypeResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedPackageDefinitionResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/PackageDefinitionResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedPackageMigrationStatusResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/PackageMigrationStatusResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedRecycleBinItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/RecycleBinItemResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedRedirectUrlResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/RedirectUrlResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedRelationItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/RelationItemResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedRelationResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/RelationResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedSavedLogSearchResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/SavedLogSearchResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedSearchResultResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/SearchResultResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedSearcherResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/SearcherResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedSnippetItemResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/SnippetItemResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedStylesheetOverviewResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/StylesheetOverviewResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedTagResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TagResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedTelemetryResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TelemetryResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedUserGroupResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserGroupResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PagedUserResponseModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserResponseModel"
}
]
}
}
},
"additionalProperties": false
},
"PartialViewItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FileItemResponseModelBaseModel"
}
],
"additionalProperties": false
},
"PartialViewResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TextFileResponseModelBaseModel"
}
],
"additionalProperties": false
},
"PartialViewSnippetResponseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"content": {
"type": "string"
}
},
"additionalProperties": false
},
"PartialViewUpdateModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TextFileUpdateModel"
}
],
"additionalProperties": false
},
"PathFolderModelBaseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FolderModelBaseModel"
}
],
"additionalProperties": false
},
"PathFolderResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FolderModelBaseModel"
}
],
"properties": {
"parentPath": {
"type": "string",
"nullable": true
},
"path": {
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"ProblemDetailsModel": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"ProfilingStatusRequestModel": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ProfilingStatusResponseModel": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"PropertyTypeAppearanceModel": {
"type": "object",
"properties": {
"labelOnTop": {
"type": "boolean"
}
},
"additionalProperties": false
},
"PropertyTypeContainerModelBaseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"type": {
"type": "string"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PropertyTypeModelBaseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"containerId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"dataTypeId": {
"type": "string",
"format": "uuid"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"validation": {
"oneOf": [
{
"$ref": "#/components/schemas/PropertyTypeValidationModel"
}
]
},
"appearance": {
"oneOf": [
{
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
}
]
}
},
"additionalProperties": false
},
"PropertyTypeValidationModel": {
"type": "object",
"properties": {
"mandatory": {
"type": "boolean"
},
"mandatoryMessage": {
"type": "string",
"nullable": true
},
"regEx": {
"type": "string",
"nullable": true
},
"regExMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PublishedStateModel": {
"enum": [
"Published",
"Unpublished",
"Publishing",
"Unpublishing"
],
"type": "integer",
"format": "int32"
},
"RecycleBinItemResponseModel": {
"required": [
"$type"
],
"type": "object",
"properties": {
"$type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
},
"isContainer": {
"type": "boolean"
},
"parentId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"RecycleBinItemResponseModel": "#/components/schemas/RecycleBinItemResponseModel"
}
}
},
"RedirectStatusModel": {
"enum": [
"Enabled",
"Disabled"
],
"type": "integer",
"format": "int32"
},
"RedirectUrlResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"originalUrl": {
"type": "string"
},
"destinationUrl": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time"
},
"contentId": {
"type": "string",
"format": "uuid"
},
"culture": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RedirectUrlStatusResponseModel": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/RedirectStatusModel"
},
"userIsAdmin": {
"type": "boolean"
}
},
"additionalProperties": false
},
"RelationItemResponseModel": {
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"format": "uuid"
},
"nodeName": {
"type": "string",
"nullable": true
},
"nodeType": {
"type": "string",
"nullable": true
},
"nodePublished": {
"type": "boolean",
"nullable": true
},
"contentTypeIcon": {
"type": "string",
"nullable": true
},
"contentTypeAlias": {
"type": "string",
"nullable": true
},
"contentTypeName": {
"type": "string",
"nullable": true
},
"relationTypeName": {
"type": "string",
"nullable": true
},
"relationTypeIsBidirectional": {
"type": "boolean"
},
"relationTypeIsDependency": {
"type": "boolean"
}
},
"additionalProperties": false
},
"RelationResponseModel": {
"type": "object",
"properties": {
"parentId": {
"type": "integer",
"format": "int32"
},
"parentName": {
"type": "string",
"nullable": true
},
"childId": {
"type": "integer",
"format": "int32"
},
"childName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time"
},
"comment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RelationTypeBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"isBidirectional": {
"type": "boolean"
},
"parentObjectType": {
"type": "string",
"format": "uuid",
"nullable": true
},
"childObjectType": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isDependency": {
"type": "boolean"
}
},
"additionalProperties": false
},
"RelationTypeItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"additionalProperties": false
},
"RelationTypeResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/RelationTypeBaseModel"
}
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"alias": {
"type": "string",
"nullable": true
},
"path": {
"type": "string"
},
"isSystemRelationType": {
"type": "boolean"
},
"parentObjectTypeName": {
"type": "string",
"nullable": true
},
"childObjectTypeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RichTextRuleModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"selector": {
"type": "string"
},
"styles": {
"type": "string"
}
},
"additionalProperties": false
},
"RichTextStylesheetRulesResponseModel": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/RichTextRuleModel"
}
]
}
}
},
"additionalProperties": false
},
"RuntimeLevelModel": {
"enum": [
"Unknown",
"Boot",
"Install",
"Upgrade",
"Run",
"BootFailed"
],
"type": "integer",
"format": "int32"
},
"SavedLogSearchPresenationBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"query": {
"type": "string"
}
},
"additionalProperties": false
},
"SavedLogSearchRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SavedLogSearchPresenationBaseModel"
}
],
"additionalProperties": false
},
"SavedLogSearchResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SavedLogSearchPresenationBaseModel"
}
],
"additionalProperties": false
},
"ScriptItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FileItemResponseModelBaseModel"
}
],
"additionalProperties": false
},
"ScriptResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TextFileResponseModelBaseModel"
}
],
"additionalProperties": false
},
"ScriptUpdateModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TextFileUpdateModel"
}
],
"additionalProperties": false
},
"ScriptViewModelBaseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TextFileViewModelBaseModel"
}
],
"additionalProperties": false
},
"SearchResultResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"score": {
"type": "number",
"format": "float"
},
"fieldCount": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"fields": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/FieldPresentationModel"
}
]
}
}
},
"additionalProperties": false
},
"SearcherResponseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"ServerStatusResponseModel": {
"type": "object",
"properties": {
"serverStatus": {
"$ref": "#/components/schemas/RuntimeLevelModel"
}
},
"additionalProperties": false
},
"SetAvatarRequestModel": {
"type": "object",
"properties": {
"fileId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"SetTourStatusRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TourStatusModel"
}
],
"additionalProperties": false
},
"SnippetItemResponseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"StaticFileItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FileItemResponseModelBaseModel"
}
],
"additionalProperties": false
},
"StatusResultTypeModel": {
"enum": [
"Success",
"Warning",
"Error",
"Info"
],
"type": "integer",
"format": "int32"
},
"StylesheetItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FileItemResponseModelBaseModel"
}
],
"additionalProperties": false
},
"StylesheetOverviewResponseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"path": {
"type": "string"
}
},
"additionalProperties": false
},
"StylesheetResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TextFileResponseModelBaseModel"
}
],
"additionalProperties": false
},
"StylesheetUpdateModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TextFileUpdateModel"
}
],
"additionalProperties": false
},
"TagResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"text": {
"type": "string",
"nullable": true
},
"group": {
"type": "string",
"nullable": true
},
"nodeCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TelemetryLevelModel": {
"enum": [
"Minimal",
"Basic",
"Detailed"
],
"type": "integer",
"format": "int32"
},
"TelemetryRepresentationBaseModel": {
"type": "object",
"properties": {
"telemetryLevel": {
"$ref": "#/components/schemas/TelemetryLevelModel"
}
},
"additionalProperties": false
},
"TelemetryRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TelemetryRepresentationBaseModel"
}
],
"additionalProperties": false
},
"TelemetryResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TelemetryRepresentationBaseModel"
}
],
"additionalProperties": false
},
"TemplateItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"properties": {
"alias": {
"type": "string"
}
},
"additionalProperties": false
},
"TemplateModelBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"content": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TemplateQueryExecuteFilterPresentationModel": {
"type": "object",
"properties": {
"propertyAlias": {
"type": "string"
},
"constraintValue": {
"type": "string"
},
"operator": {
"$ref": "#/components/schemas/OperatorModel"
}
},
"additionalProperties": false
},
"TemplateQueryExecuteModel": {
"type": "object",
"properties": {
"rootContentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"contentTypeAlias": {
"type": "string",
"nullable": true
},
"filters": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateQueryExecuteFilterPresentationModel"
}
]
},
"nullable": true
},
"sort": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateQueryExecuteSortModel"
}
],
"nullable": true
},
"take": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TemplateQueryExecuteSortModel": {
"type": "object",
"properties": {
"propertyAlias": {
"type": "string"
},
"direction": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TemplateQueryOperatorModel": {
"type": "object",
"properties": {
"operator": {
"$ref": "#/components/schemas/OperatorModel"
},
"applicableTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateQueryPropertyTypeModel"
}
}
},
"additionalProperties": false
},
"TemplateQueryPropertyPresentationModel": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateQueryPropertyTypeModel"
}
},
"additionalProperties": false
},
"TemplateQueryPropertyTypeModel": {
"enum": [
"String",
"DateTime",
"Integer"
],
"type": "integer",
"format": "int32"
},
"TemplateQueryResultItemPresentationModel": {
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"TemplateQueryResultResponseModel": {
"type": "object",
"properties": {
"queryExpression": {
"type": "string"
},
"sampleResults": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateQueryResultItemPresentationModel"
}
]
}
},
"resultCount": {
"type": "integer",
"format": "int32"
},
"executionTime": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TemplateQuerySettingsResponseModel": {
"type": "object",
"properties": {
"contentTypeAliases": {
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateQueryPropertyPresentationModel"
}
]
}
},
"operators": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateQueryOperatorModel"
}
]
}
}
},
"additionalProperties": false
},
"TemplateResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TemplateModelBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"masterTemplateId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"TemplateResponseModel": "#/components/schemas/TemplateResponseModel"
}
}
},
"TemplateScaffoldResponseModel": {
"type": "object",
"properties": {
"content": {
"type": "string"
}
},
"additionalProperties": false
},
"TemporaryFileResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"availableUntil": {
"type": "string",
"format": "date-time",
"nullable": true
},
"fileName": {
"type": "string"
}
},
"additionalProperties": false
},
"TextFileResponseModelBaseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TextFileViewModelBaseModel"
}
],
"properties": {
"path": {
"type": "string"
}
},
"additionalProperties": false
},
"TextFileUpdateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"content": {
"type": "string"
},
"existingPath": {
"type": "string"
}
},
"additionalProperties": false
},
"TextFileViewModelBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"content": {
"type": "string"
}
},
"additionalProperties": false
},
"TourStatusModel": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"completed": {
"type": "boolean"
},
"disabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TreeItemPresentationModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
}
},
"additionalProperties": false
},
"UnlockUsersRequestModel": {
"type": "object",
"properties": {
"userIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"additionalProperties": false
},
"UpdateContentRequestModelBaseDocumentValueModelDocumentVariantRequestModel": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentValueModel"
}
]
}
},
"variants": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DocumentVariantRequestModel"
}
]
}
}
},
"additionalProperties": false
},
"UpdateContentRequestModelBaseMediaValueModelMediaVariantRequestModel": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MediaValueModel"
}
]
}
},
"variants": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MediaVariantRequestModel"
}
]
}
}
},
"additionalProperties": false
},
"UpdateContentTypeRequestModelBaseUpdateDocumentTypePropertyTypeRequestModelUpdateDocumentTypePropertyTypeContainerRequestModel": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"icon": {
"type": "string"
},
"allowedAsRoot": {
"type": "boolean"
},
"variesByCulture": {
"type": "boolean"
},
"variesBySegment": {
"type": "boolean"
},
"isElement": {
"type": "boolean"
},
"properties": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateDocumentTypePropertyTypeRequestModel"
}
]
}
},
"containers": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UpdateDocumentTypePropertyTypeContainerRequestModel"
}
]
}
},
"allowedContentTypes": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTypeSortModel"
}
]
}
},
"compositions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTypeCompositionModel"
}
]
}
}
},
"additionalProperties": false
},
"UpdateDataTypeRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/DataTypeModelBaseModel"
}
],
"additionalProperties": false
},
"UpdateDictionaryItemRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/DictionaryItemModelBaseModel"
}
],
"additionalProperties": false
},
"UpdateDocumentNotificationsRequestModel": {
"type": "object",
"properties": {
"subscribedActionIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"UpdateDocumentRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/UpdateContentRequestModelBaseDocumentValueModelDocumentVariantRequestModel"
}
],
"properties": {
"templateId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateDocumentTypePropertyTypeContainerRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PropertyTypeContainerModelBaseModel"
}
],
"additionalProperties": false
},
"UpdateDocumentTypePropertyTypeRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PropertyTypeModelBaseModel"
}
],
"additionalProperties": false
},
"UpdateDocumentTypeRequestModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/UpdateContentTypeRequestModelBaseUpdateDocumentTypePropertyTypeRequestModelUpdateDocumentTypePropertyTypeContainerRequestModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"allowedTemplateIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"defaultTemplateId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"cleanup": {
"oneOf": [
{
"$ref": "#/components/schemas/ContentTypeCleanupModel"
}
]
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"UpdateDocumentTypeRequestModel": "#/components/schemas/UpdateDocumentTypeRequestModel"
}
}
},
"UpdateDomainsRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/DomainsPresentationModelBaseModel"
}
],
"additionalProperties": false
},
"UpdateFolderReponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FolderModelBaseModel"
}
],
"additionalProperties": false
},
"UpdateLanguageRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/LanguageModelBaseModel"
}
],
"additionalProperties": false
},
"UpdateMediaRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/UpdateContentRequestModelBaseMediaValueModelMediaVariantRequestModel"
}
],
"additionalProperties": false
},
"UpdatePackageRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PackageModelBaseModel"
}
],
"properties": {
"packagePath": {
"type": "string"
}
},
"additionalProperties": false
},
"UpdatePartialViewRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TextFileUpdateModel"
}
],
"additionalProperties": false
},
"UpdateRelationTypeRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/RelationTypeBaseModel"
}
],
"additionalProperties": false
},
"UpdateScriptRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/UpdateTextFileViewModelBaseModel"
}
],
"additionalProperties": false
},
"UpdateStylesheetRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/UpdateTextFileViewModelBaseModel"
}
],
"additionalProperties": false
},
"UpdateTemplateRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TemplateModelBaseModel"
}
],
"additionalProperties": false
},
"UpdateTextFileViewModelBaseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/TextFileViewModelBaseModel"
}
],
"properties": {
"existingPath": {
"type": "string"
}
},
"additionalProperties": false
},
"UpdateUserGroupRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/UserGroupBaseModel"
}
],
"additionalProperties": false
},
"UpdateUserGroupsOnUserRequestModel": {
"type": "object",
"properties": {
"userIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"userGroupIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"additionalProperties": false
},
"UpdateUserRequestModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/UserPresentationBaseModel"
}
],
"properties": {
"languageIsoCode": {
"type": "string"
},
"contentStartNodeIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"mediaStartNodeIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"additionalProperties": false
},
"UpgradeSettingsResponseModel": {
"type": "object",
"properties": {
"currentState": {
"type": "string"
},
"newState": {
"type": "string"
},
"newVersion": {
"type": "string"
},
"oldVersion": {
"type": "string"
},
"reportUrl": {
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"UserDataModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "string"
}
},
"additionalProperties": false
},
"UserDataResponseModel": {
"type": "object",
"properties": {
"userData": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserDataModel"
}
]
}
}
},
"additionalProperties": false
},
"UserGroupBaseModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"icon": {
"type": "string",
"nullable": true
},
"sections": {
"type": "array",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"hasAccessToAllLanguages": {
"type": "boolean"
},
"documentStartNodeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"mediaStartNodeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"permissions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"UserGroupItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"properties": {
"icon": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UserGroupResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/UserGroupBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"UserGroupResponseModel": "#/components/schemas/UserGroupResponseModel"
}
}
},
"UserInstallResponseModel": {
"required": [
"email",
"name",
"password"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"email": {
"minLength": 1,
"type": "string",
"format": "email"
},
"password": {
"minLength": 1,
"type": "string"
},
"subscribeToNewsletter": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"UserItemResponseModel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItemResponseModelBaseModel"
}
],
"additionalProperties": false
},
"UserOrderModel": {
"enum": [
"UserName",
"Language",
"Name",
"Email",
"Id",
"CreateDate",
"UpdateDate",
"IsApproved",
"IsLockedOut",
"LastLoginDate"
],
"type": "integer",
"format": "int32"
},
"UserPermissionModel": {
"type": "object",
"properties": {
"nodeKey": {
"type": "string",
"format": "uuid"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"UserPermissionsResponseModel": {
"type": "object",
"properties": {
"permissions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/UserPermissionModel"
}
]
}
}
},
"additionalProperties": false
},
"UserPresentationBaseModel": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"userName": {
"type": "string"
},
"name": {
"type": "string"
},
"userGroupIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"additionalProperties": false
},
"UserResponseModel": {
"required": [
"$type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/UserPresentationBaseModel"
}
],
"properties": {
"$type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"languageIsoCode": {
"type": "string",
"nullable": true
},
"contentStartNodeIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"mediaStartNodeIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"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": "string",
"format": "date-time",
"nullable": true
},
"lastLockoutDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastPasswordChangeDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"UserResponseModel": "#/components/schemas/UserResponseModel"
}
}
},
"UserSettingsModel": {
"type": "object",
"properties": {
"minCharLength": {
"type": "integer",
"format": "int32"
},
"minNonAlphaNumericLength": {
"type": "integer",
"format": "int32"
},
"consentLevels": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ConsentLevelPresentationModel"
}
]
}
}
},
"additionalProperties": false
},
"UserStateModel": {
"enum": [
"Active",
"Disabled",
"LockedOut",
"Invited",
"Inactive",
"All"
],
"type": "integer",
"format": "int32"
},
"UserTourStatusesResponseModel": {
"type": "object",
"properties": {
"tourStatuses": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TourStatusModel"
},
{
"$ref": "#/components/schemas/SetTourStatusRequestModel"
}
]
}
}
},
"additionalProperties": false
},
"ValueModelBaseModel": {
"required": [
"$type"
],
"type": "object",
"properties": {
"$type": {
"type": "string"
},
"culture": {
"type": "string",
"nullable": true
},
"segment": {
"type": "string",
"nullable": true
},
"alias": {
"type": "string"
},
"value": {
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"MediaValueModel": "#/components/schemas/MediaValueModel",
"DocumentValueModel": "#/components/schemas/DocumentValueModel"
}
}
},
"VariantModelBaseModel": {
"required": [
"$type"
],
"type": "object",
"properties": {
"$type": {
"type": "string"
},
"culture": {
"type": "string",
"nullable": true
},
"segment": {
"type": "string",
"nullable": true
},
"name": {
"type": "string"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"MediaVariantRequestModel": "#/components/schemas/MediaVariantRequestModel",
"MediaVariantResponseModel": "#/components/schemas/MediaVariantResponseModel",
"DocumentVariantRequestModel": "#/components/schemas/DocumentVariantRequestModel",
"DocumentVariantResponseModel": "#/components/schemas/DocumentVariantResponseModel"
}
}
},
"VariantResponseModelBaseModel": {
"required": [
"$type"
],
"type": "object",
"properties": {
"$type": {
"type": "string"
},
"culture": {
"type": "string",
"nullable": true
},
"segment": {
"type": "string",
"nullable": true
},
"name": {
"type": "string"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updateDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"MediaVariantResponseModel": "#/components/schemas/MediaVariantResponseModel",
"DocumentVariantResponseModel": "#/components/schemas/DocumentVariantResponseModel"
}
}
},
"VariantTreeItemModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"culture": {
"type": "string",
"nullable": true
},
"state": {
"$ref": "#/components/schemas/PublishedStateModel"
}
},
"additionalProperties": false
},
"VersionResponseModel": {
"type": "object",
"properties": {
"version": {
"type": "string"
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Backoffice User": {
"type": "oauth2",
"description": "Umbraco Authentication",
"flows": {
"authorizationCode": {
"authorizationUrl": "/umbraco/management/api/v1.0/security/back-office/authorize",
"tokenUrl": "/umbraco/management/api/v1.0/security/back-office/token",
"scopes": { }
}
}
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink