yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
fdf416550ada17765453613cd09d508e0d7f4962
Umbraco-CMS/src/Umbraco.Cms.Api.Management/OpenApi.json
Kenn Jacobsen fdf416550a Refactor dictionary bulk action APIs (#13786) 
* Sanitize dictionary overview and export actions

* Amend dictionary services with async and attempt pattern + isolate temporary file handling in its own service.

* Update OpenAPI schema to match new dictionary bulk actions

* Update src/Umbraco.Cms.Api.Management/Services/DictionaryItemImportService.cs

Co-authored-by: Mole <nikolajlauridsen@protonmail.ch>

* Update src/Umbraco.Cms.Api.Management/Services/DictionaryItemImportService.cs

Co-authored-by: Mole <nikolajlauridsen@protonmail.ch>

* Update src/Umbraco.Cms.Api.Management/Services/TemporaryFileService.cs

Co-authored-by: Mole <nikolajlauridsen@protonmail.ch>

* Update src/Umbraco.Cms.Api.Management/ViewModels/Dictionary/DictionaryImportModel.cs

Co-authored-by: Mole <nikolajlauridsen@protonmail.ch>

* Refactor - split dictionary import handling into smaller methods

* Rename view model due to name clash in new SwaggerGen + update OpenAPI JSON file

---------

Co-authored-by: Mole <nikolajlauridsen@protonmail.ch>
2023-02-08 13:18:08 +01:00

9061 lines
218 KiB
JSON
Raw Blame History

{
"openapi": "3.0.1",
"info": {
"title": "Umbraco Backoffice API",
"description": "This shows all APIs available in this version of Umbraco - including all the legacy apis that are available for backward compatibility",
"version": "1.0"
},
"paths": {
"/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/PagedCultureModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/data-type": {
"post": {
"tags": [
"Data Type"
],
"operationId": "PostDataType",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataTypeCreateModel"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/data-type/{key}": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetDataTypeByKey",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataTypeModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Data Type"
],
"operationId": "DeleteDataTypeByKey",
"parameters": [
{
"name": "key",
"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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
},
"put": {
"tags": [
"Data Type"
],
"operationId": "PutDataTypeByKey",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataTypeUpdateModel"
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/data-type/{key}/references": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetDataTypeByKeyReferences",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypeReferenceModel"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/data-type/folder": {
"post": {
"tags": [
"Data Type"
],
"operationId": "PostDataTypeFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderCreateModel"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/umbraco/management/api/v1/data-type/folder/{key}": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetDataTypeFolderByKey",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Data Type"
],
"operationId": "DeleteDataTypeFolderByKey",
"parameters": [
{
"name": "key",
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Data Type"
],
"operationId": "PutDataTypeFolderByKey",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderUpdateModel"
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/data-type/children": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetTreeDataTypeChildren",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFolderTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/data-type/item": {
"get": {
"tags": [
"Data Type"
],
"operationId": "GetTreeDataTypeItem",
"parameters": [
{
"name": "key",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedFolderTreeItemModel"
}
}
}
}
}
}
},
"/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/PagedDictionaryOverviewModel"
}
}
}
}
}
},
"post": {
"tags": [
"Dictionary"
],
"operationId": "PostDictionary",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DictionaryItemCreateModel"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/dictionary/{key}": {
"get": {
"tags": [
"Dictionary"
],
"operationId": "GetDictionaryByKey",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DictionaryItemModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Dictionary"
],
"operationId": "DeleteDictionaryByKey",
"parameters": [
{
"name": "key",
"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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
},
"put": {
"tags": [
"Dictionary"
],
"operationId": "PutDictionaryByKey",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DictionaryItemUpdateModel"
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/dictionary/{key}/export": {
"get": {
"tags": [
"Dictionary"
],
"operationId": "GetDictionaryByKeyExport",
"parameters": [
{
"name": "key",
"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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResultModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/dictionary/import": {
"post": {
"tags": [
"Dictionary"
],
"operationId": "PostDictionaryImport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DictionaryImportModel"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/dictionary/upload": {
"post": {
"tags": [
"Dictionary"
],
"operationId": "PostDictionaryUpload",
"requestBody": {
"content": { }
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DictionaryUploadModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/dictionary/children": {
"get": {
"tags": [
"Dictionary"
],
"operationId": "GetTreeDictionaryChildren",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedEntityTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/dictionary/item": {
"get": {
"tags": [
"Dictionary"
],
"operationId": "GetTreeDictionaryItem",
"parameters": [
{
"name": "key",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedEntityTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document-blueprint/item": {
"get": {
"tags": [
"Document Blueprint"
],
"operationId": "GetTreeDocumentBlueprintItem",
"parameters": [
{
"name": "key",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentBlueprintTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedDocumentBlueprintTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document-type/children": {
"get": {
"tags": [
"Document Type"
],
"operationId": "GetTreeDocumentTypeChildren",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedDocumentTypeTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document-type/item": {
"get": {
"tags": [
"Document Type"
],
"operationId": "GetTreeDocumentTypeItem",
"parameters": [
{
"name": "key",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedDocumentTypeTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/recycle-bin/document/children": {
"get": {
"tags": [
"Document"
],
"operationId": "GetRecycleBinDocumentChildren",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRecycleBinItemModel"
}
}
}
}
}
}
},
"/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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRecycleBinItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document/children": {
"get": {
"tags": [
"Document"
],
"operationId": "GetTreeDocumentChildren",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "dataTypeKey",
"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/PagedDocumentTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/document/item": {
"get": {
"tags": [
"Document"
],
"operationId": "GetTreeDocumentItem",
"parameters": [
{
"name": "key",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "dataTypeKey",
"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": {
"$ref": "#/components/schemas/DocumentTreeItemModel"
}
}
}
}
}
}
}
},
"/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": "dataTypeKey",
"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/PagedDocumentTreeItemModel"
}
}
}
}
}
}
},
"/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/PagedHealthCheckGroupModel"
}
}
}
}
}
}
},
"/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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResultModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckGroupWithResultModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/health-check/execute-action": {
"post": {
"tags": [
"Health Check"
],
"operationId": "PostHealthCheckExecuteAction",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckActionModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckResultModel"
}
}
}
}
}
}
},
"/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/PagedHelpPageModel"
}
}
}
}
}
}
},
"/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/PagedIndexModel"
}
}
}
}
}
}
},
"/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": {
"$ref": "#/components/schemas/IndexModel"
}
}
}
}
}
}
},
"/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"
}
}
}
}
}
}
},
"/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": {
"$ref": "#/components/schemas/InstallSettingsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/install/setup": {
"post": {
"tags": [
"Install"
],
"operationId": "PostInstallSetup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallModel"
}
}
}
},
"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": {
"$ref": "#/components/schemas/DatabaseInstallModel"
}
}
}
},
"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/PagedLanguageModel"
}
}
}
}
}
},
"post": {
"tags": [
"Language"
],
"operationId": "PostLanguage",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageCreateModel"
}
}
}
},
"responses": {
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"201": {
"description": "Created"
}
}
}
},
"/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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageModel"
}
}
}
}
}
},
"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"
}
}
},
"put": {
"tags": [
"Language"
],
"operationId": "PutLanguageByIsoCode",
"parameters": [
{
"name": "isoCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageUpdateModel"
}
}
}
},
"responses": {
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResultModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success"
}
}
}
},
"/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/PagedLoggerModel"
}
}
}
}
}
}
},
"/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"
}
}
}
},
"/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/PagedLogMessageModel"
}
}
}
}
}
}
},
"/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/PagedLogTemplateModel"
}
}
}
}
}
}
},
"/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/PagedSavedLogSearchModel"
}
}
}
}
}
},
"post": {
"tags": [
"Log Viewer"
],
"operationId": "PostLogViewerSavedSearch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedLogSearchModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"201": {
"description": "Created"
}
}
}
},
"/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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResultModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedLogSearchModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Log Viewer"
],
"operationId": "DeleteLogViewerSavedSearchByName",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResultModel"
}
}
}
},
"200": {
"description": "Success"
}
}
}
},
"/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"
}
}
}
},
"/umbraco/management/api/v1/tree/media-type/children": {
"get": {
"tags": [
"Media Type"
],
"operationId": "GetTreeMediaTypeChildren",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "foldersOnly",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedFolderTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/media-type/item": {
"get": {
"tags": [
"Media Type"
],
"operationId": "GetTreeMediaTypeItem",
"parameters": [
{
"name": "key",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedFolderTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/recycle-bin/media/children": {
"get": {
"tags": [
"Media"
],
"operationId": "GetRecycleBinMediaChildren",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRecycleBinItemModel"
}
}
}
}
}
}
},
"/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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRecycleBinItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/media/children": {
"get": {
"tags": [
"Media"
],
"operationId": "GetTreeMediaChildren",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "dataTypeKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedContentTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/media/item": {
"get": {
"tags": [
"Media"
],
"operationId": "GetTreeMediaItem",
"parameters": [
{
"name": "key",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "dataTypeKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContentTreeItemModel"
}
}
}
}
}
}
}
},
"/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": "dataTypeKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedContentTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/member-group/item": {
"get": {
"tags": [
"Member Group"
],
"operationId": "GetTreeMemberGroupItem",
"parameters": [
{
"name": "key",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedEntityTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/member-type/item": {
"get": {
"tags": [
"Member Type"
],
"operationId": "GetTreeMemberTypeItem",
"parameters": [
{
"name": "key",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedEntityTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/models-builder/build": {
"post": {
"tags": [
"Models Builder"
],
"operationId": "PostModelsBuilderBuild",
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResultModel"
}
}
}
},
"428": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/models-builder/dashboard": {
"get": {
"tags": [
"Models Builder"
],
"operationId": "GetModelsBuilderDashboard",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelsBuilderModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/models-builder/status": {
"get": {
"tags": [
"Models Builder"
],
"operationId": "GetModelsBuilderStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutOfDateStatusModel"
}
}
}
}
}
}
},
"/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/PagedFileSystemTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/partial-view/item": {
"get": {
"tags": [
"Partial View"
],
"operationId": "GetTreePartialViewItem",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedFileSystemTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/profiling/status": {
"get": {
"tags": [
"Profiling"
],
"operationId": "GetProfilingStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfilingStatusModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/published-cache/collect": {
"post": {
"tags": [
"Published Cache"
],
"operationId": "PostPublishedCacheCollect",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/umbraco/management/api/v1/published-cache/rebuild": {
"post": {
"tags": [
"Published Cache"
],
"operationId": "PostPublishedCacheRebuild",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/umbraco/management/api/v1/published-cache/reload": {
"post": {
"tags": [
"Published Cache"
],
"operationId": "PostPublishedCacheReload",
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/umbraco/management/api/v1/published-cache/status": {
"get": {
"tags": [
"Published Cache"
],
"operationId": "GetPublishedCacheStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/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/PagedRedirectUrlModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/redirect-management/{key}": {
"get": {
"tags": [
"Redirect Management"
],
"operationId": "GetRedirectManagementByKey",
"parameters": [
{
"name": "key",
"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/PagedRedirectUrlModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Redirect Management"
],
"operationId": "DeleteRedirectManagementByKey",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/umbraco/management/api/v1/redirect-management/status": {
"get": {
"tags": [
"Redirect Management"
],
"operationId": "GetRedirectManagementStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedirectUrlStatusModel"
}
}
}
}
}
},
"post": {
"tags": [
"Redirect Management"
],
"operationId": "PostRedirectManagementStatus",
"parameters": [
{
"name": "status",
"in": "query",
"schema": {
"$ref": "#/components/schemas/RedirectStatusModel"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/umbraco/management/api/v1/tree/relation-type/item": {
"get": {
"tags": [
"Relation Type"
],
"operationId": "GetTreeRelationTypeItem",
"parameters": [
{
"name": "key",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedEntityTreeItemModel"
}
}
}
}
}
}
},
"/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": {
"$ref": "#/components/schemas/RelationModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResultModel"
}
}
}
}
}
}
},
"/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/PagedRelationModel"
}
}
}
}
}
}
},
"/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/PagedFileSystemTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/script/item": {
"get": {
"tags": [
"Script"
],
"operationId": "GetTreeScriptItem",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedFileSystemTreeItemModel"
}
}
}
}
}
}
},
"/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/PagedSearcherModel"
}
}
}
}
}
}
},
"/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/PagedSearchResultModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/security/back-office/authorize": {
"get": {
"tags": [
"Security"
],
"operationId": "GetSecurityBackOfficeAuthorize",
"responses": {
"200": {
"description": "Success"
}
}
},
"post": {
"tags": [
"Security"
],
"operationId": "PostSecurityBackOfficeAuthorize",
"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": {
"$ref": "#/components/schemas/ServerStatusModel"
}
}
}
}
}
}
},
"/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": {
"$ref": "#/components/schemas/VersionModel"
}
}
}
}
}
}
},
"/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/PagedFileSystemTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/static-file/item": {
"get": {
"tags": [
"Static File"
],
"operationId": "GetTreeStaticFileItem",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedFileSystemTreeItemModel"
}
}
}
}
}
}
},
"/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/PagedFileSystemTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/stylesheet/item": {
"get": {
"tags": [
"Stylesheet"
],
"operationId": "GetTreeStylesheetItem",
"parameters": [
{
"name": "path",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedFileSystemTreeItemModel"
}
}
}
}
}
}
},
"/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/PagedTelemetryModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/telemetry/level": {
"get": {
"tags": [
"Telemetry"
],
"operationId": "GetTelemetryLevel",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelemetryModel"
}
}
}
}
}
},
"post": {
"tags": [
"Telemetry"
],
"operationId": "PostTelemetryLevel",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelemetryModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"200": {
"description": "Success"
}
}
}
},
"/umbraco/management/api/v1/template": {
"post": {
"tags": [
"Template"
],
"operationId": "PostTemplate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateCreateModel"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/template/{key}": {
"get": {
"tags": [
"Template"
],
"operationId": "GetTemplateByKey",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
},
"delete": {
"tags": [
"Template"
],
"operationId": "DeleteTemplateByKey",
"parameters": [
{
"name": "key",
"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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
},
"put": {
"tags": [
"Template"
],
"operationId": "PutTemplateByKey",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateUpdateModel"
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/template/query/execute": {
"post": {
"tags": [
"Template"
],
"operationId": "PostTemplateQueryExecute",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateQueryExecuteModel"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateQueryResultModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/template/query/settings": {
"get": {
"tags": [
"Template"
],
"operationId": "GetTemplateQuerySettings",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateQuerySettingsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/template/scaffold": {
"get": {
"tags": [
"Template"
],
"operationId": "GetTemplateScaffold",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateScaffoldModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/template/children": {
"get": {
"tags": [
"Template"
],
"operationId": "GetTreeTemplateChildren",
"parameters": [
{
"name": "parentKey",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedEntityTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tree/template/item": {
"get": {
"tags": [
"Template"
],
"operationId": "GetTreeTemplateItem",
"parameters": [
{
"name": "key",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTreeItemModel"
}
}
}
}
}
}
}
},
"/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/PagedEntityTreeItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tracked-reference/{id}": {
"get": {
"tags": [
"Tracked Reference"
],
"operationId": "GetTrackedReferenceById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"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"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRelationItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tracked-reference/descendants/{parentId}": {
"get": {
"tags": [
"Tracked Reference"
],
"operationId": "GetTrackedReferenceDescendantsByParentId",
"parameters": [
{
"name": "parentId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"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"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRelationItemModel"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/tracked-reference/item": {
"get": {
"tags": [
"Tracked Reference"
],
"operationId": "GetTrackedReferenceItem",
"parameters": [
{
"name": "ids",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"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"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedRelationItemModel"
}
}
}
}
}
}
},
"/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"
}
}
}
}
}
}
},
"/umbraco/management/api/v1/upgrade/settings": {
"get": {
"tags": [
"Upgrade"
],
"operationId": "GetUpgradeSettings",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpgradeSettingsModel"
}
}
}
},
"428": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsModel"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AssemblyModel": {
"type": "object",
"properties": {
"definedTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TypeInfoModel"
},
"readOnly": true
},
"exportedTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TypeModel"
},
"readOnly": true
},
"codeBase": {
"type": "string",
"nullable": true,
"readOnly": true,
"deprecated": true
},
"entryPoint": {
"$ref": "#/components/schemas/MethodInfoModel"
},
"fullName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"imageRuntimeVersion": {
"type": "string",
"readOnly": true
},
"isDynamic": {
"type": "boolean",
"readOnly": true
},
"location": {
"type": "string",
"readOnly": true
},
"reflectionOnly": {
"type": "boolean",
"readOnly": true
},
"isCollectible": {
"type": "boolean",
"readOnly": true
},
"isFullyTrusted": {
"type": "boolean",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"escapedCodeBase": {
"type": "string",
"readOnly": true,
"deprecated": true
},
"manifestModule": {
"$ref": "#/components/schemas/ModuleModel"
},
"modules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleModel"
},
"readOnly": true
},
"globalAssemblyCache": {
"type": "boolean",
"readOnly": true,
"deprecated": true
},
"hostContext": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"securityRuleSet": {
"$ref": "#/components/schemas/SecurityRuleSetModel"
}
},
"additionalProperties": false
},
"CallingConventionsModel": {
"enum": [
"Standard",
"VarArgs",
"Any",
"HasThis",
"ExplicitThis"
],
"type": "integer",
"format": "int32"
},
"ConsentLevelModel": {
"type": "object",
"properties": {
"level": {
"$ref": "#/components/schemas/TelemetryLevelModel"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
},
"ConstructorInfoModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"declaringType": {
"$ref": "#/components/schemas/TypeModel"
},
"reflectedType": {
"$ref": "#/components/schemas/TypeModel"
},
"module": {
"$ref": "#/components/schemas/ModuleModel"
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"isCollectible": {
"type": "boolean",
"readOnly": true
},
"metadataToken": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"attributes": {
"$ref": "#/components/schemas/MethodAttributesModel"
},
"methodImplementationFlags": {
"$ref": "#/components/schemas/MethodImplAttributesModel"
},
"callingConvention": {
"$ref": "#/components/schemas/CallingConventionsModel"
},
"isAbstract": {
"type": "boolean",
"readOnly": true
},
"isConstructor": {
"type": "boolean",
"readOnly": true
},
"isFinal": {
"type": "boolean",
"readOnly": true
},
"isHideBySig": {
"type": "boolean",
"readOnly": true
},
"isSpecialName": {
"type": "boolean",
"readOnly": true
},
"isStatic": {
"type": "boolean",
"readOnly": true
},
"isVirtual": {
"type": "boolean",
"readOnly": true
},
"isAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamily": {
"type": "boolean",
"readOnly": true
},
"isFamilyAndAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamilyOrAssembly": {
"type": "boolean",
"readOnly": true
},
"isPrivate": {
"type": "boolean",
"readOnly": true
},
"isPublic": {
"type": "boolean",
"readOnly": true
},
"isConstructedGenericMethod": {
"type": "boolean",
"readOnly": true
},
"isGenericMethod": {
"type": "boolean",
"readOnly": true
},
"isGenericMethodDefinition": {
"type": "boolean",
"readOnly": true
},
"containsGenericParameters": {
"type": "boolean",
"readOnly": true
},
"methodHandle": {
"$ref": "#/components/schemas/RuntimeMethodHandleModel"
},
"isSecurityCritical": {
"type": "boolean",
"readOnly": true
},
"isSecuritySafeCritical": {
"type": "boolean",
"readOnly": true
},
"isSecurityTransparent": {
"type": "boolean",
"readOnly": true
},
"memberType": {
"$ref": "#/components/schemas/MemberTypesModel"
}
},
"additionalProperties": false
},
"ContentTreeItemModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
},
"key": {
"type": "string",
"format": "uuid"
},
"isContainer": {
"type": "boolean"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
},
"noAccess": {
"type": "boolean"
},
"isTrashed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CreatedResultModel": {
"type": "object",
"properties": {
"value": {
"nullable": true
},
"formatters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IOutputFormatterModel"
}
},
"contentTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"declaredType": {
"$ref": "#/components/schemas/TypeModel"
},
"statusCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"location": {
"type": "string"
}
},
"additionalProperties": false
},
"CultureModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"englishName": {
"type": "string"
}
},
"additionalProperties": false
},
"CustomAttributeDataModel": {
"type": "object",
"properties": {
"attributeType": {
"$ref": "#/components/schemas/TypeModel"
},
"constructor": {
"$ref": "#/components/schemas/ConstructorInfoModel"
},
"constructorArguments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeTypedArgumentModel"
},
"readOnly": true
},
"namedArguments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeNamedArgumentModel"
},
"readOnly": true
}
},
"additionalProperties": false
},
"CustomAttributeNamedArgumentModel": {
"type": "object",
"properties": {
"memberInfo": {
"$ref": "#/components/schemas/MemberInfoModel"
},
"typedValue": {
"$ref": "#/components/schemas/CustomAttributeTypedArgumentModel"
},
"memberName": {
"type": "string",
"readOnly": true
},
"isField": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"CustomAttributeTypedArgumentModel": {
"type": "object",
"properties": {
"argumentType": {
"$ref": "#/components/schemas/TypeModel"
},
"value": {
"nullable": true
}
},
"additionalProperties": false
},
"DataTypeCreateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"propertyEditorAlias": {
"type": "string"
},
"propertyEditorUiAlias": {
"type": "string",
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypePropertyModel"
}
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"DataTypeModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"propertyEditorAlias": {
"type": "string"
},
"propertyEditorUiAlias": {
"type": "string",
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypePropertyModel"
}
},
"key": {
"type": "string",
"format": "uuid"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"DataTypePropertyModel": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"value": {
"nullable": true
}
},
"additionalProperties": false
},
"DataTypePropertyReferenceModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"alias": {
"type": "string"
}
},
"additionalProperties": false
},
"DataTypeReferenceModel": {
"type": "object",
"properties": {
"key": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypePropertyReferenceModel"
}
}
},
"additionalProperties": false
},
"DataTypeUpdateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"propertyEditorAlias": {
"type": "string"
},
"propertyEditorUiAlias": {
"type": "string",
"nullable": true
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTypePropertyModel"
}
}
},
"additionalProperties": false
},
"DatabaseInstallModel": {
"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
},
"DatabaseSettingsModel": {
"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
},
"DictionaryImportModel": {
"type": "object",
"properties": {
"fileName": {
"type": "string"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"DictionaryItemCreateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryItemTranslationModel"
}
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"DictionaryItemModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryItemTranslationModel"
}
},
"key": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"DictionaryItemTranslationModel": {
"type": "object",
"properties": {
"isoCode": {
"type": "string"
},
"translation": {
"type": "string"
}
},
"additionalProperties": false
},
"DictionaryItemUpdateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryItemTranslationModel"
}
}
},
"additionalProperties": false
},
"DictionaryItemsImportModel": {
"type": "object",
"properties": {
"key": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"DictionaryOverviewModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"key": {
"type": "string",
"format": "uuid"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
},
"translatedIsoCodes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"DictionaryUploadModel": {
"type": "object",
"properties": {
"dictionaryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryItemsImportModel"
}
},
"fileName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DirectionModel": {
"enum": [
"Ascending",
"Descending"
],
"type": "integer",
"format": "int32"
},
"DocumentBlueprintTreeItemModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
},
"key": {
"type": "string",
"format": "uuid"
},
"isContainer": {
"type": "boolean"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
},
"documentTypeKey": {
"type": "string",
"format": "uuid"
},
"documentTypeAlias": {
"type": "string"
},
"documentTypeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DocumentTreeItemModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
},
"key": {
"type": "string",
"format": "uuid"
},
"isContainer": {
"type": "boolean"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
},
"noAccess": {
"type": "boolean"
},
"isTrashed": {
"type": "boolean"
},
"isProtected": {
"type": "boolean"
},
"isPublished": {
"type": "boolean"
},
"isEdited": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DocumentTypeTreeItemModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
},
"key": {
"type": "string",
"format": "uuid"
},
"isContainer": {
"type": "boolean"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isFolder": {
"type": "boolean"
},
"isElement": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EntityTreeItemModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
},
"key": {
"type": "string",
"format": "uuid"
},
"isContainer": {
"type": "boolean"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"EventAttributesModel": {
"enum": [
"None",
"SpecialName",
"RTSpecialName",
"ReservedMask"
],
"type": "integer",
"format": "int32"
},
"EventInfoModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"declaringType": {
"$ref": "#/components/schemas/TypeModel"
},
"reflectedType": {
"$ref": "#/components/schemas/TypeModel"
},
"module": {
"$ref": "#/components/schemas/ModuleModel"
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"isCollectible": {
"type": "boolean",
"readOnly": true
},
"metadataToken": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"memberType": {
"$ref": "#/components/schemas/MemberTypesModel"
},
"attributes": {
"$ref": "#/components/schemas/EventAttributesModel"
},
"isSpecialName": {
"type": "boolean",
"readOnly": true
},
"addMethod": {
"$ref": "#/components/schemas/MethodInfoModel"
},
"removeMethod": {
"$ref": "#/components/schemas/MethodInfoModel"
},
"raiseMethod": {
"$ref": "#/components/schemas/MethodInfoModel"
},
"isMulticast": {
"type": "boolean",
"readOnly": true
},
"eventHandlerType": {
"$ref": "#/components/schemas/TypeModel"
}
},
"additionalProperties": false
},
"FieldAttributesModel": {
"enum": [
"PrivateScope",
"Private",
"FamANDAssem",
"Assembly",
"Family",
"FamORAssem",
"Public",
"FieldAccessMask",
"Static",
"InitOnly",
"Literal",
"NotSerialized",
"HasFieldRVA",
"SpecialName",
"RTSpecialName",
"HasFieldMarshal",
"PinvokeImpl",
"HasDefault",
"ReservedMask"
],
"type": "integer",
"format": "int32"
},
"FieldInfoModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"declaringType": {
"$ref": "#/components/schemas/TypeModel"
},
"reflectedType": {
"$ref": "#/components/schemas/TypeModel"
},
"module": {
"$ref": "#/components/schemas/ModuleModel"
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"isCollectible": {
"type": "boolean",
"readOnly": true
},
"metadataToken": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"memberType": {
"$ref": "#/components/schemas/MemberTypesModel"
},
"attributes": {
"$ref": "#/components/schemas/FieldAttributesModel"
},
"fieldType": {
"$ref": "#/components/schemas/TypeModel"
},
"isInitOnly": {
"type": "boolean",
"readOnly": true
},
"isLiteral": {
"type": "boolean",
"readOnly": true
},
"isNotSerialized": {
"type": "boolean",
"readOnly": true
},
"isPinvokeImpl": {
"type": "boolean",
"readOnly": true
},
"isSpecialName": {
"type": "boolean",
"readOnly": true
},
"isStatic": {
"type": "boolean",
"readOnly": true
},
"isAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamily": {
"type": "boolean",
"readOnly": true
},
"isFamilyAndAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamilyOrAssembly": {
"type": "boolean",
"readOnly": true
},
"isPrivate": {
"type": "boolean",
"readOnly": true
},
"isPublic": {
"type": "boolean",
"readOnly": true
},
"isSecurityCritical": {
"type": "boolean",
"readOnly": true
},
"isSecuritySafeCritical": {
"type": "boolean",
"readOnly": true
},
"isSecurityTransparent": {
"type": "boolean",
"readOnly": true
},
"fieldHandle": {
"$ref": "#/components/schemas/RuntimeFieldHandleModel"
}
},
"additionalProperties": false
},
"FieldModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"FileSystemTreeItemModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
},
"path": {
"type": "string"
},
"isFolder": {
"type": "boolean"
}
},
"additionalProperties": false
},
"FolderCreateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"FolderModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"key": {
"type": "string",
"format": "uuid"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"FolderTreeItemModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
},
"key": {
"type": "string",
"format": "uuid"
},
"isContainer": {
"type": "boolean"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isFolder": {
"type": "boolean"
}
},
"additionalProperties": false
},
"FolderUpdateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"GenericParameterAttributesModel": {
"enum": [
"None",
"Covariant",
"Contravariant",
"VarianceMask",
"ReferenceTypeConstraint",
"NotNullableValueTypeConstraint",
"DefaultConstructorConstraint",
"SpecialConstraintMask"
],
"type": "integer",
"format": "int32"
},
"HealthCheckActionModel": {
"type": "object",
"properties": {
"healthCheckKey": {
"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
},
"HealthCheckGroupModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"checks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthCheckModel"
}
}
},
"additionalProperties": false
},
"HealthCheckGroupWithResultModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"checks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthCheckWithResultModel"
}
}
},
"additionalProperties": false
},
"HealthCheckModel": {
"type": "object",
"properties": {
"key": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"HealthCheckResultModel": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"resultType": {
"$ref": "#/components/schemas/StatusResultTypeModel"
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthCheckActionModel"
},
"nullable": true
},
"readMoreLink": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"HealthCheckWithResultModel": {
"type": "object",
"properties": {
"key": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthCheckResultModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"HealthStatusModel": {
"enum": [
"Healthy",
"Unhealthy",
"Rebuilding"
],
"type": "integer",
"format": "int32"
},
"HelpPageModel": {
"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
},
"ICustomAttributeProviderModel": {
"type": "object",
"additionalProperties": false
},
"IOutputFormatterModel": {
"type": "object",
"additionalProperties": false
},
"IndexModel": {
"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
},
"InstallModel": {
"required": [
"database",
"user"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserInstallModel"
},
"database": {
"$ref": "#/components/schemas/DatabaseInstallModel"
},
"telemetryLevel": {
"$ref": "#/components/schemas/TelemetryLevelModel"
}
},
"additionalProperties": false
},
"InstallSettingsModel": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserSettingsModel"
},
"databases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatabaseSettingsModel"
}
}
},
"additionalProperties": false
},
"IntPtrModel": {
"type": "object",
"additionalProperties": false
},
"LanguageCreateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"isMandatory": {
"type": "boolean"
},
"fallbackIsoCode": {
"type": "string",
"nullable": true
},
"isoCode": {
"type": "string"
}
},
"additionalProperties": false
},
"LanguageModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"isMandatory": {
"type": "boolean"
},
"fallbackIsoCode": {
"type": "string",
"nullable": true
},
"isoCode": {
"type": "string"
}
},
"additionalProperties": false
},
"LanguageUpdateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"isMandatory": {
"type": "boolean"
},
"fallbackIsoCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LayoutKindModel": {
"enum": [
"Sequential",
"Explicit",
"Auto"
],
"type": "integer",
"format": "int32"
},
"LogLevelModel": {
"enum": [
"Verbose",
"Debug",
"Information",
"Warning",
"Error",
"Fatal"
],
"type": "integer",
"format": "int32"
},
"LogMessageModel": {
"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": {
"$ref": "#/components/schemas/LogMessagePropertyModel"
}
},
"exception": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LogMessagePropertyModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LogTemplateModel": {
"type": "object",
"properties": {
"messageTemplate": {
"type": "string",
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"LoggerModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"level": {
"$ref": "#/components/schemas/LogLevelModel"
}
},
"additionalProperties": false
},
"MemberInfoModel": {
"type": "object",
"properties": {
"memberType": {
"$ref": "#/components/schemas/MemberTypesModel"
},
"name": {
"type": "string",
"readOnly": true
},
"declaringType": {
"$ref": "#/components/schemas/TypeModel"
},
"reflectedType": {
"$ref": "#/components/schemas/TypeModel"
},
"module": {
"$ref": "#/components/schemas/ModuleModel"
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"isCollectible": {
"type": "boolean",
"readOnly": true
},
"metadataToken": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"MemberTypesModel": {
"enum": [
"Constructor",
"Event",
"Field",
"Method",
"Property",
"TypeInfo",
"Custom",
"NestedType",
"All"
],
"type": "integer",
"format": "int32"
},
"MethodAttributesModel": {
"enum": [
"ReuseSlot",
"PrivateScope",
"Private",
"FamANDAssem",
"Assembly",
"Family",
"FamORAssem",
"Public",
"MemberAccessMask",
"UnmanagedExport",
"Static",
"Final",
"Virtual",
"HideBySig",
"NewSlot",
"VtableLayoutMask",
"CheckAccessOnOverride",
"Abstract",
"SpecialName",
"RTSpecialName",
"PinvokeImpl",
"HasSecurity",
"RequireSecObject",
"ReservedMask"
],
"type": "integer",
"format": "int32"
},
"MethodBaseModel": {
"type": "object",
"properties": {
"memberType": {
"$ref": "#/components/schemas/MemberTypesModel"
},
"name": {
"type": "string",
"readOnly": true
},
"declaringType": {
"$ref": "#/components/schemas/TypeModel"
},
"reflectedType": {
"$ref": "#/components/schemas/TypeModel"
},
"module": {
"$ref": "#/components/schemas/ModuleModel"
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"isCollectible": {
"type": "boolean",
"readOnly": true
},
"metadataToken": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"attributes": {
"$ref": "#/components/schemas/MethodAttributesModel"
},
"methodImplementationFlags": {
"$ref": "#/components/schemas/MethodImplAttributesModel"
},
"callingConvention": {
"$ref": "#/components/schemas/CallingConventionsModel"
},
"isAbstract": {
"type": "boolean",
"readOnly": true
},
"isConstructor": {
"type": "boolean",
"readOnly": true
},
"isFinal": {
"type": "boolean",
"readOnly": true
},
"isHideBySig": {
"type": "boolean",
"readOnly": true
},
"isSpecialName": {
"type": "boolean",
"readOnly": true
},
"isStatic": {
"type": "boolean",
"readOnly": true
},
"isVirtual": {
"type": "boolean",
"readOnly": true
},
"isAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamily": {
"type": "boolean",
"readOnly": true
},
"isFamilyAndAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamilyOrAssembly": {
"type": "boolean",
"readOnly": true
},
"isPrivate": {
"type": "boolean",
"readOnly": true
},
"isPublic": {
"type": "boolean",
"readOnly": true
},
"isConstructedGenericMethod": {
"type": "boolean",
"readOnly": true
},
"isGenericMethod": {
"type": "boolean",
"readOnly": true
},
"isGenericMethodDefinition": {
"type": "boolean",
"readOnly": true
},
"containsGenericParameters": {
"type": "boolean",
"readOnly": true
},
"methodHandle": {
"$ref": "#/components/schemas/RuntimeMethodHandleModel"
},
"isSecurityCritical": {
"type": "boolean",
"readOnly": true
},
"isSecuritySafeCritical": {
"type": "boolean",
"readOnly": true
},
"isSecurityTransparent": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"MethodImplAttributesModel": {
"enum": [
"IL",
"Managed",
"Native",
"OPTIL",
"Runtime",
"CodeTypeMask",
"Unmanaged",
"ManagedMask",
"NoInlining",
"ForwardRef",
"Synchronized",
"NoOptimization",
"PreserveSig",
"AggressiveInlining",
"AggressiveOptimization",
"InternalCall",
"MaxMethodImplVal"
],
"type": "integer",
"format": "int32"
},
"MethodInfoModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"declaringType": {
"$ref": "#/components/schemas/TypeModel"
},
"reflectedType": {
"$ref": "#/components/schemas/TypeModel"
},
"module": {
"$ref": "#/components/schemas/ModuleModel"
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"isCollectible": {
"type": "boolean",
"readOnly": true
},
"metadataToken": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"attributes": {
"$ref": "#/components/schemas/MethodAttributesModel"
},
"methodImplementationFlags": {
"$ref": "#/components/schemas/MethodImplAttributesModel"
},
"callingConvention": {
"$ref": "#/components/schemas/CallingConventionsModel"
},
"isAbstract": {
"type": "boolean",
"readOnly": true
},
"isConstructor": {
"type": "boolean",
"readOnly": true
},
"isFinal": {
"type": "boolean",
"readOnly": true
},
"isHideBySig": {
"type": "boolean",
"readOnly": true
},
"isSpecialName": {
"type": "boolean",
"readOnly": true
},
"isStatic": {
"type": "boolean",
"readOnly": true
},
"isVirtual": {
"type": "boolean",
"readOnly": true
},
"isAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamily": {
"type": "boolean",
"readOnly": true
},
"isFamilyAndAssembly": {
"type": "boolean",
"readOnly": true
},
"isFamilyOrAssembly": {
"type": "boolean",
"readOnly": true
},
"isPrivate": {
"type": "boolean",
"readOnly": true
},
"isPublic": {
"type": "boolean",
"readOnly": true
},
"isConstructedGenericMethod": {
"type": "boolean",
"readOnly": true
},
"isGenericMethod": {
"type": "boolean",
"readOnly": true
},
"isGenericMethodDefinition": {
"type": "boolean",
"readOnly": true
},
"containsGenericParameters": {
"type": "boolean",
"readOnly": true
},
"methodHandle": {
"$ref": "#/components/schemas/RuntimeMethodHandleModel"
},
"isSecurityCritical": {
"type": "boolean",
"readOnly": true
},
"isSecuritySafeCritical": {
"type": "boolean",
"readOnly": true
},
"isSecurityTransparent": {
"type": "boolean",
"readOnly": true
},
"memberType": {
"$ref": "#/components/schemas/MemberTypesModel"
},
"returnParameter": {
"$ref": "#/components/schemas/ParameterInfoModel"
},
"returnType": {
"$ref": "#/components/schemas/TypeModel"
},
"returnTypeCustomAttributes": {
"$ref": "#/components/schemas/ICustomAttributeProviderModel"
}
},
"additionalProperties": false
},
"ModelsBuilderModel": {
"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"
},
"ModuleHandleModel": {
"type": "object",
"properties": {
"mdStreamVersion": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"ModuleModel": {
"type": "object",
"properties": {
"assembly": {
"$ref": "#/components/schemas/AssemblyModel"
},
"fullyQualifiedName": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"mdStreamVersion": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"moduleVersionId": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"scopeName": {
"type": "string",
"readOnly": true
},
"moduleHandle": {
"$ref": "#/components/schemas/ModuleHandleModel"
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"metadataToken": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"NotFoundResultModel": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32"
}
},
"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"
},
"OutOfDateStatusModel": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/OutOfDateTypeModel"
}
},
"additionalProperties": false
},
"OutOfDateTypeModel": {
"enum": [
"OutOfDate",
"Current",
"Unknown"
],
"type": "integer",
"format": "int32"
},
"PagedContentTreeItemModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContentTreeItemModel"
}
}
},
"additionalProperties": false
},
"PagedCultureModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CultureModel"
}
}
},
"additionalProperties": false
},
"PagedDictionaryOverviewModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DictionaryOverviewModel"
}
}
},
"additionalProperties": false
},
"PagedDocumentBlueprintTreeItemModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentBlueprintTreeItemModel"
}
}
},
"additionalProperties": false
},
"PagedDocumentTreeItemModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTreeItemModel"
}
}
},
"additionalProperties": false
},
"PagedDocumentTypeTreeItemModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypeTreeItemModel"
}
}
},
"additionalProperties": false
},
"PagedEntityTreeItemModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTreeItemModel"
}
}
},
"additionalProperties": false
},
"PagedFileSystemTreeItemModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileSystemTreeItemModel"
}
}
},
"additionalProperties": false
},
"PagedFolderTreeItemModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderTreeItemModel"
}
}
},
"additionalProperties": false
},
"PagedHealthCheckGroupModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthCheckGroupModel"
}
}
},
"additionalProperties": false
},
"PagedHelpPageModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HelpPageModel"
}
}
},
"additionalProperties": false
},
"PagedIndexModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexModel"
}
}
},
"additionalProperties": false
},
"PagedLanguageModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageModel"
}
}
},
"additionalProperties": false
},
"PagedLogMessageModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogMessageModel"
}
}
},
"additionalProperties": false
},
"PagedLogTemplateModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogTemplateModel"
}
}
},
"additionalProperties": false
},
"PagedLoggerModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoggerModel"
}
}
},
"additionalProperties": false
},
"PagedRecycleBinItemModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecycleBinItemModel"
}
}
},
"additionalProperties": false
},
"PagedRedirectUrlModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RedirectUrlModel"
}
}
},
"additionalProperties": false
},
"PagedRelationItemModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelationItemModel"
}
}
},
"additionalProperties": false
},
"PagedRelationModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelationModel"
}
}
},
"additionalProperties": false
},
"PagedSavedLogSearchModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedLogSearchModel"
}
}
},
"additionalProperties": false
},
"PagedSearchResultModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchResultModel"
}
}
},
"additionalProperties": false
},
"PagedSearcherModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearcherModel"
}
}
},
"additionalProperties": false
},
"PagedTelemetryModel": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TelemetryModel"
}
}
},
"additionalProperties": false
},
"ParameterAttributesModel": {
"enum": [
"None",
"In",
"Out",
"Lcid",
"Retval",
"Optional",
"HasDefault",
"HasFieldMarshal",
"Reserved3",
"Reserved4",
"ReservedMask"
],
"type": "integer",
"format": "int32"
},
"ParameterInfoModel": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ParameterAttributesModel"
},
"member": {
"$ref": "#/components/schemas/MemberInfoModel"
},
"name": {
"type": "string",
"nullable": true,
"readOnly": true
},
"parameterType": {
"$ref": "#/components/schemas/TypeModel"
},
"position": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"isIn": {
"type": "boolean",
"readOnly": true
},
"isLcid": {
"type": "boolean",
"readOnly": true
},
"isOptional": {
"type": "boolean",
"readOnly": true
},
"isOut": {
"type": "boolean",
"readOnly": true
},
"isRetval": {
"type": "boolean",
"readOnly": true
},
"defaultValue": {
"nullable": true,
"readOnly": true
},
"rawDefaultValue": {
"nullable": true,
"readOnly": true
},
"hasDefaultValue": {
"type": "boolean",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"metadataToken": {
"type": "integer",
"format": "int32",
"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": { }
},
"ProfilingStatusModel": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"PropertyAttributesModel": {
"enum": [
"None",
"SpecialName",
"RTSpecialName",
"HasDefault",
"Reserved2",
"Reserved3",
"Reserved4",
"ReservedMask"
],
"type": "integer",
"format": "int32"
},
"PropertyInfoModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"declaringType": {
"$ref": "#/components/schemas/TypeModel"
},
"reflectedType": {
"$ref": "#/components/schemas/TypeModel"
},
"module": {
"$ref": "#/components/schemas/ModuleModel"
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"isCollectible": {
"type": "boolean",
"readOnly": true
},
"metadataToken": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"memberType": {
"$ref": "#/components/schemas/MemberTypesModel"
},
"propertyType": {
"$ref": "#/components/schemas/TypeModel"
},
"attributes": {
"$ref": "#/components/schemas/PropertyAttributesModel"
},
"isSpecialName": {
"type": "boolean",
"readOnly": true
},
"canRead": {
"type": "boolean",
"readOnly": true
},
"canWrite": {
"type": "boolean",
"readOnly": true
},
"getMethod": {
"$ref": "#/components/schemas/MethodInfoModel"
},
"setMethod": {
"$ref": "#/components/schemas/MethodInfoModel"
}
},
"additionalProperties": false
},
"RecycleBinItemModel": {
"type": "object",
"properties": {
"key": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"icon": {
"type": "string"
},
"hasChildren": {
"type": "boolean"
},
"isContainer": {
"type": "boolean"
},
"parentKey": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"RedirectStatusModel": {
"enum": [
"Enabled",
"Disabled"
],
"type": "integer",
"format": "int32"
},
"RedirectUrlModel": {
"type": "object",
"properties": {
"key": {
"type": "string",
"format": "uuid"
},
"originalUrl": {
"type": "string"
},
"destinationUrl": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time"
},
"contentKey": {
"type": "string",
"format": "uuid"
},
"culture": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RedirectUrlStatusModel": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/RedirectStatusModel"
},
"userIsAdmin": {
"type": "boolean"
}
},
"additionalProperties": false
},
"RelationItemModel": {
"type": "object",
"properties": {
"nodeKey": {
"type": "string",
"format": "uuid"
},
"nodeName": {
"type": "string",
"nullable": true
},
"nodeType": {
"type": "string",
"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
},
"RelationModel": {
"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
},
"RuntimeFieldHandleModel": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/IntPtrModel"
}
},
"additionalProperties": false
},
"RuntimeLevelModel": {
"enum": [
"Unknown",
"Boot",
"Install",
"Upgrade",
"Run",
"BootFailed"
],
"type": "integer",
"format": "int32"
},
"RuntimeMethodHandleModel": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/IntPtrModel"
}
},
"additionalProperties": false
},
"RuntimeTypeHandleModel": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/IntPtrModel"
}
},
"additionalProperties": false
},
"SavedLogSearchModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"query": {
"type": "string"
}
},
"additionalProperties": false
},
"SearchResultModel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"score": {
"type": "number",
"format": "float"
},
"fieldCount": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldModel"
}
}
},
"additionalProperties": false
},
"SearcherModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"SecurityRuleSetModel": {
"enum": [
"None",
"Level1",
"Level2"
],
"type": "integer",
"format": "int32"
},
"ServerStatusModel": {
"type": "object",
"properties": {
"serverStatus": {
"$ref": "#/components/schemas/RuntimeLevelModel"
}
},
"additionalProperties": false
},
"StatusResultTypeModel": {
"enum": [
"Success",
"Warning",
"Error",
"Info"
],
"type": "integer",
"format": "int32"
},
"StructLayoutAttributeModel": {
"type": "object",
"properties": {
"typeId": {
"readOnly": true
},
"value": {
"$ref": "#/components/schemas/LayoutKindModel"
}
},
"additionalProperties": false
},
"TelemetryLevelModel": {
"enum": [
"Minimal",
"Basic",
"Detailed"
],
"type": "integer",
"format": "int32"
},
"TelemetryModel": {
"type": "object",
"properties": {
"telemetryLevel": {
"$ref": "#/components/schemas/TelemetryLevelModel"
}
},
"additionalProperties": false
},
"TemplateCreateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"content": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TemplateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"content": {
"type": "string",
"nullable": true
},
"key": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TemplateQueryExecuteFilterModel": {
"type": "object",
"properties": {
"propertyAlias": {
"type": "string"
},
"constraintValue": {
"type": "string"
},
"operator": {
"$ref": "#/components/schemas/OperatorModel"
}
},
"additionalProperties": false
},
"TemplateQueryExecuteModel": {
"type": "object",
"properties": {
"rootContentKey": {
"type": "string",
"format": "uuid",
"nullable": true
},
"contentTypeAlias": {
"type": "string",
"nullable": true
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateQueryExecuteFilterModel"
},
"nullable": true
},
"sort": {
"$ref": "#/components/schemas/TemplateQueryExecuteSortModel"
},
"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
},
"TemplateQueryPropertyModel": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateQueryPropertyTypeModel"
}
},
"additionalProperties": false
},
"TemplateQueryPropertyTypeModel": {
"enum": [
"String",
"DateTime",
"Integer"
],
"type": "integer",
"format": "int32"
},
"TemplateQueryResultItemModel": {
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"TemplateQueryResultModel": {
"type": "object",
"properties": {
"queryExpression": {
"type": "string"
},
"sampleResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateQueryResultItemModel"
}
},
"resultCount": {
"type": "integer",
"format": "int32"
},
"executionTime": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TemplateQuerySettingsModel": {
"type": "object",
"properties": {
"contentTypeAliases": {
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateQueryPropertyModel"
}
},
"operators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateQueryOperatorModel"
}
}
},
"additionalProperties": false
},
"TemplateScaffoldModel": {
"type": "object",
"properties": {
"content": {
"type": "string"
}
},
"additionalProperties": false
},
"TemplateUpdateModel": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"content": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TypeAttributesModel": {
"enum": [
"NotPublic",
"AutoLayout",
"AnsiClass",
"Class",
"Public",
"NestedPublic",
"NestedPrivate",
"NestedFamily",
"NestedAssembly",
"NestedFamANDAssem",
"NestedFamORAssem",
"VisibilityMask",
"SequentialLayout",
"ExplicitLayout",
"LayoutMask",
"Interface",
"ClassSemanticsMask",
"Abstract",
"Sealed",
"SpecialName",
"RTSpecialName",
"Import",
"Serializable",
"WindowsRuntime",
"UnicodeClass",
"AutoClass",
"CustomFormatClass",
"StringFormatMask",
"HasSecurity",
"ReservedMask",
"BeforeFieldInit",
"CustomFormatMask"
],
"type": "integer",
"format": "int32"
},
"TypeInfoModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"isCollectible": {
"type": "boolean",
"readOnly": true
},
"metadataToken": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"isInterface": {
"type": "boolean",
"readOnly": true
},
"memberType": {
"$ref": "#/components/schemas/MemberTypesModel"
},
"namespace": {
"type": "string",
"nullable": true,
"readOnly": true
},
"assemblyQualifiedName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"fullName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"assembly": {
"$ref": "#/components/schemas/AssemblyModel"
},
"module": {
"$ref": "#/components/schemas/ModuleModel"
},
"isNested": {
"type": "boolean",
"readOnly": true
},
"declaringType": {
"$ref": "#/components/schemas/TypeModel"
},
"declaringMethod": {
"$ref": "#/components/schemas/MethodBaseModel"
},
"reflectedType": {
"$ref": "#/components/schemas/TypeModel"
},
"underlyingSystemType": {
"$ref": "#/components/schemas/TypeModel"
},
"isTypeDefinition": {
"type": "boolean",
"readOnly": true
},
"isArray": {
"type": "boolean",
"readOnly": true
},
"isByRef": {
"type": "boolean",
"readOnly": true
},
"isPointer": {
"type": "boolean",
"readOnly": true
},
"isConstructedGenericType": {
"type": "boolean",
"readOnly": true
},
"isGenericParameter": {
"type": "boolean",
"readOnly": true
},
"isGenericTypeParameter": {
"type": "boolean",
"readOnly": true
},
"isGenericMethodParameter": {
"type": "boolean",
"readOnly": true
},
"isGenericType": {
"type": "boolean",
"readOnly": true
},
"isGenericTypeDefinition": {
"type": "boolean",
"readOnly": true
},
"isSZArray": {
"type": "boolean",
"readOnly": true
},
"isVariableBoundArray": {
"type": "boolean",
"readOnly": true
},
"isByRefLike": {
"type": "boolean",
"readOnly": true
},
"hasElementType": {
"type": "boolean",
"readOnly": true
},
"genericTypeArguments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TypeModel"
},
"readOnly": true
},
"genericParameterPosition": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"genericParameterAttributes": {
"$ref": "#/components/schemas/GenericParameterAttributesModel"
},
"attributes": {
"$ref": "#/components/schemas/TypeAttributesModel"
},
"isAbstract": {
"type": "boolean",
"readOnly": true
},
"isImport": {
"type": "boolean",
"readOnly": true
},
"isSealed": {
"type": "boolean",
"readOnly": true
},
"isSpecialName": {
"type": "boolean",
"readOnly": true
},
"isClass": {
"type": "boolean",
"readOnly": true
},
"isNestedAssembly": {
"type": "boolean",
"readOnly": true
},
"isNestedFamANDAssem": {
"type": "boolean",
"readOnly": true
},
"isNestedFamily": {
"type": "boolean",
"readOnly": true
},
"isNestedFamORAssem": {
"type": "boolean",
"readOnly": true
},
"isNestedPrivate": {
"type": "boolean",
"readOnly": true
},
"isNestedPublic": {
"type": "boolean",
"readOnly": true
},
"isNotPublic": {
"type": "boolean",
"readOnly": true
},
"isPublic": {
"type": "boolean",
"readOnly": true
},
"isAutoLayout": {
"type": "boolean",
"readOnly": true
},
"isExplicitLayout": {
"type": "boolean",
"readOnly": true
},
"isLayoutSequential": {
"type": "boolean",
"readOnly": true
},
"isAnsiClass": {
"type": "boolean",
"readOnly": true
},
"isAutoClass": {
"type": "boolean",
"readOnly": true
},
"isUnicodeClass": {
"type": "boolean",
"readOnly": true
},
"isCOMObject": {
"type": "boolean",
"readOnly": true
},
"isContextful": {
"type": "boolean",
"readOnly": true
},
"isEnum": {
"type": "boolean",
"readOnly": true
},
"isMarshalByRef": {
"type": "boolean",
"readOnly": true
},
"isPrimitive": {
"type": "boolean",
"readOnly": true
},
"isValueType": {
"type": "boolean",
"readOnly": true
},
"isSignatureType": {
"type": "boolean",
"readOnly": true
},
"isSecurityCritical": {
"type": "boolean",
"readOnly": true
},
"isSecuritySafeCritical": {
"type": "boolean",
"readOnly": true
},
"isSecurityTransparent": {
"type": "boolean",
"readOnly": true
},
"structLayoutAttribute": {
"$ref": "#/components/schemas/StructLayoutAttributeModel"
},
"typeInitializer": {
"$ref": "#/components/schemas/ConstructorInfoModel"
},
"typeHandle": {
"$ref": "#/components/schemas/RuntimeTypeHandleModel"
},
"guid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"baseType": {
"$ref": "#/components/schemas/TypeModel"
},
"isSerializable": {
"type": "boolean",
"readOnly": true
},
"containsGenericParameters": {
"type": "boolean",
"readOnly": true
},
"isVisible": {
"type": "boolean",
"readOnly": true
},
"genericTypeParameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TypeModel"
},
"readOnly": true
},
"declaredConstructors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConstructorInfoModel"
},
"readOnly": true
},
"declaredEvents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventInfoModel"
},
"readOnly": true
},
"declaredFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldInfoModel"
},
"readOnly": true
},
"declaredMembers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberInfoModel"
},
"readOnly": true
},
"declaredMethods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MethodInfoModel"
},
"readOnly": true
},
"declaredNestedTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TypeInfoModel"
},
"readOnly": true
},
"declaredProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PropertyInfoModel"
},
"readOnly": true
},
"implementedInterfaces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TypeModel"
},
"readOnly": true
}
},
"additionalProperties": false
},
"TypeModel": {
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttributeDataModel"
},
"readOnly": true
},
"isCollectible": {
"type": "boolean",
"readOnly": true
},
"metadataToken": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"isInterface": {
"type": "boolean",
"readOnly": true
},
"memberType": {
"$ref": "#/components/schemas/MemberTypesModel"
},
"namespace": {
"type": "string",
"nullable": true,
"readOnly": true
},
"assemblyQualifiedName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"fullName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"assembly": {
"$ref": "#/components/schemas/AssemblyModel"
},
"module": {
"$ref": "#/components/schemas/ModuleModel"
},
"isNested": {
"type": "boolean",
"readOnly": true
},
"declaringType": {
"$ref": "#/components/schemas/TypeModel"
},
"declaringMethod": {
"$ref": "#/components/schemas/MethodBaseModel"
},
"reflectedType": {
"$ref": "#/components/schemas/TypeModel"
},
"underlyingSystemType": {
"$ref": "#/components/schemas/TypeModel"
},
"isTypeDefinition": {
"type": "boolean",
"readOnly": true
},
"isArray": {
"type": "boolean",
"readOnly": true
},
"isByRef": {
"type": "boolean",
"readOnly": true
},
"isPointer": {
"type": "boolean",
"readOnly": true
},
"isConstructedGenericType": {
"type": "boolean",
"readOnly": true
},
"isGenericParameter": {
"type": "boolean",
"readOnly": true
},
"isGenericTypeParameter": {
"type": "boolean",
"readOnly": true
},
"isGenericMethodParameter": {
"type": "boolean",
"readOnly": true
},
"isGenericType": {
"type": "boolean",
"readOnly": true
},
"isGenericTypeDefinition": {
"type": "boolean",
"readOnly": true
},
"isSZArray": {
"type": "boolean",
"readOnly": true
},
"isVariableBoundArray": {
"type": "boolean",
"readOnly": true
},
"isByRefLike": {
"type": "boolean",
"readOnly": true
},
"hasElementType": {
"type": "boolean",
"readOnly": true
},
"genericTypeArguments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TypeModel"
},
"readOnly": true
},
"genericParameterPosition": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"genericParameterAttributes": {
"$ref": "#/components/schemas/GenericParameterAttributesModel"
},
"attributes": {
"$ref": "#/components/schemas/TypeAttributesModel"
},
"isAbstract": {
"type": "boolean",
"readOnly": true
},
"isImport": {
"type": "boolean",
"readOnly": true
},
"isSealed": {
"type": "boolean",
"readOnly": true
},
"isSpecialName": {
"type": "boolean",
"readOnly": true
},
"isClass": {
"type": "boolean",
"readOnly": true
},
"isNestedAssembly": {
"type": "boolean",
"readOnly": true
},
"isNestedFamANDAssem": {
"type": "boolean",
"readOnly": true
},
"isNestedFamily": {
"type": "boolean",
"readOnly": true
},
"isNestedFamORAssem": {
"type": "boolean",
"readOnly": true
},
"isNestedPrivate": {
"type": "boolean",
"readOnly": true
},
"isNestedPublic": {
"type": "boolean",
"readOnly": true
},
"isNotPublic": {
"type": "boolean",
"readOnly": true
},
"isPublic": {
"type": "boolean",
"readOnly": true
},
"isAutoLayout": {
"type": "boolean",
"readOnly": true
},
"isExplicitLayout": {
"type": "boolean",
"readOnly": true
},
"isLayoutSequential": {
"type": "boolean",
"readOnly": true
},
"isAnsiClass": {
"type": "boolean",
"readOnly": true
},
"isAutoClass": {
"type": "boolean",
"readOnly": true
},
"isUnicodeClass": {
"type": "boolean",
"readOnly": true
},
"isCOMObject": {
"type": "boolean",
"readOnly": true
},
"isContextful": {
"type": "boolean",
"readOnly": true
},
"isEnum": {
"type": "boolean",
"readOnly": true
},
"isMarshalByRef": {
"type": "boolean",
"readOnly": true
},
"isPrimitive": {
"type": "boolean",
"readOnly": true
},
"isValueType": {
"type": "boolean",
"readOnly": true
},
"isSignatureType": {
"type": "boolean",
"readOnly": true
},
"isSecurityCritical": {
"type": "boolean",
"readOnly": true
},
"isSecuritySafeCritical": {
"type": "boolean",
"readOnly": true
},
"isSecurityTransparent": {
"type": "boolean",
"readOnly": true
},
"structLayoutAttribute": {
"$ref": "#/components/schemas/StructLayoutAttributeModel"
},
"typeInitializer": {
"$ref": "#/components/schemas/ConstructorInfoModel"
},
"typeHandle": {
"$ref": "#/components/schemas/RuntimeTypeHandleModel"
},
"guid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"baseType": {
"$ref": "#/components/schemas/TypeModel"
},
"isSerializable": {
"type": "boolean",
"readOnly": true
},
"containsGenericParameters": {
"type": "boolean",
"readOnly": true
},
"isVisible": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"UpgradeSettingsModel": {
"type": "object",
"properties": {
"currentState": {
"type": "string"
},
"newState": {
"type": "string"
},
"newVersion": {
"type": "string"
},
"oldVersion": {
"type": "string"
},
"reportUrl": {
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"UserInstallModel": {
"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
},
"UserSettingsModel": {
"type": "object",
"properties": {
"minCharLength": {
"type": "integer",
"format": "int32"
},
"minNonAlphaNumericLength": {
"type": "integer",
"format": "int32"
},
"consentLevels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsentLevelModel"
}
}
},
"additionalProperties": false
},
"VersionModel": {
"type": "object",
"properties": {
"version": {
"type": "string"
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"OAuth": {
"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": { }
}
}
}
}
},
"security": [
{
"OAuth": [ ]
}
]
}
Reference in New Issue View Git Blame Copy Permalink