* Return not found when request for content references when entity does not exist. * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Move check for entity existence from controller to the service. * Update OpenApi.json. * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Addressed points raised in code review. * Update OpenApi.json * Resolved breaking changes. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
50360 lines
1.3 MiB
50360 lines
1.3 MiB
{
|
|
"openapi": "3.0.4",
|
|
"info": {
|
|
"title": "Umbraco Management API",
|
|
"description": "This shows all APIs available in this version of Umbraco - including all the legacy apis that are available for backward compatibility",
|
|
"version": "Latest"
|
|
},
|
|
"paths": {
|
|
"/umbraco/management/api/v1/culture": {
|
|
"get": {
|
|
"tags": [
|
|
"Culture"
|
|
],
|
|
"operationId": "GetCulture",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedCultureReponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/data-type": {
|
|
"post": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "PostDataType",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/data-type/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetDataTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DataTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "DeleteDataTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "PutDataTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/data-type/{id}/copy": {
|
|
"post": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "PostDataTypeByIdCopy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/data-type/{id}/is-used": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetDataTypeByIdIsUsed",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/data-type/{id}/move": {
|
|
"put": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "PutDataTypeByIdMove",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDataTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/data-type/{id}/referenced-by": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetDataTypeByIdReferencedBy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/data-type/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetDataTypeConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DatatypeConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/data-type/folder": {
|
|
"post": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "PostDataTypeFolder",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/data-type/folder/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetDataTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "DeleteDataTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "PutDataTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/filter/data-type": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetFilterDataType",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "name",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
},
|
|
{
|
|
"name": "editorUiAlias",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "editorAlias",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDataTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/data-type": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetItemDataType",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DataTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/data-type/search": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetItemDataTypeSearch",
|
|
"parameters": [
|
|
{
|
|
"name": "query",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedModelDataTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/data-type/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetTreeDataTypeAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DataTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/data-type/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetTreeDataTypeChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDataTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/data-type/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetTreeDataTypeRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDataTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/data-type/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Type"
|
|
],
|
|
"operationId": "GetTreeDataTypeSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "target",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetDataTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/dictionary": {
|
|
"get": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "GetDictionary",
|
|
"parameters": [
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDictionaryOverviewResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "PostDictionary",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDictionaryItemRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDictionaryItemRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDictionaryItemRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/dictionary/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "GetDictionaryById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DictionaryItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "DeleteDictionaryById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "PutDictionaryById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDictionaryItemRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDictionaryItemRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDictionaryItemRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/dictionary/{id}/export": {
|
|
"get": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "GetDictionaryByIdExport",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "includeChildren",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/dictionary/{id}/move": {
|
|
"put": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "PutDictionaryByIdMove",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDictionaryRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDictionaryRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDictionaryRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/dictionary/import": {
|
|
"post": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "PostDictionaryImport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportDictionaryRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportDictionaryRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportDictionaryRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/dictionary": {
|
|
"get": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "GetItemDictionary",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DictionaryItemItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/dictionary/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "GetTreeDictionaryAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/NamedEntityTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/dictionary/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "GetTreeDictionaryChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedNamedEntityTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/dictionary/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Dictionary"
|
|
],
|
|
"operationId": "GetTreeDictionaryRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedNamedEntityTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-blueprint": {
|
|
"post": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "PostDocumentBlueprint",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentBlueprintRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentBlueprintRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentBlueprintRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-blueprint/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "GetDocumentBlueprintById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentBlueprintResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "DeleteDocumentBlueprintById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "PutDocumentBlueprintById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentBlueprintRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentBlueprintRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentBlueprintRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-blueprint/{id}/move": {
|
|
"put": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "PutDocumentBlueprintByIdMove",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDocumentBlueprintRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDocumentBlueprintRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDocumentBlueprintRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-blueprint/{id}/scaffold": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "GetDocumentBlueprintByIdScaffold",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentBlueprintResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-blueprint/folder": {
|
|
"post": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "PostDocumentBlueprintFolder",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-blueprint/folder/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "GetDocumentBlueprintFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "DeleteDocumentBlueprintFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "PutDocumentBlueprintFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-blueprint/from-document": {
|
|
"post": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "PostDocumentBlueprintFromDocument",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentBlueprintFromDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentBlueprintFromDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentBlueprintFromDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/document-blueprint": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "GetItemDocumentBlueprint",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentBlueprintItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document-blueprint/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "GetTreeDocumentBlueprintAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentBlueprintTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document-blueprint/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "GetTreeDocumentBlueprintChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDocumentBlueprintTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document-blueprint/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "GetTreeDocumentBlueprintRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDocumentBlueprintTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document-blueprint/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Blueprint"
|
|
],
|
|
"operationId": "GetTreeDocumentBlueprintSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "target",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetDocumentBlueprintTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type": {
|
|
"post": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "PostDocumentType",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetDocumentTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "DeleteDocumentTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "PutDocumentTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/{id}/allowed-children": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetDocumentTypeByIdAllowedChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "parentContentKey",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedAllowedDocumentTypeModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/{id}/blueprint": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetDocumentTypeByIdBlueprint",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDocumentTypeBlueprintItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/{id}/composition-references": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetDocumentTypeByIdCompositionReferences",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeCompositionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/{id}/copy": {
|
|
"post": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "PostDocumentTypeByIdCopy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/{id}/export": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetDocumentTypeByIdExport",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/{id}/import": {
|
|
"put": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "PutDocumentTypeByIdImport",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/{id}/move": {
|
|
"put": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "PutDocumentTypeByIdMove",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/allowed-at-root": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetDocumentTypeAllowedAtRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedAllowedDocumentTypeModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/available-compositions": {
|
|
"post": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "PostDocumentTypeAvailableCompositions",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeCompositionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeCompositionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeCompositionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/AvailableDocumentTypeCompositionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetDocumentTypeConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/folder": {
|
|
"post": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "PostDocumentTypeFolder",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/folder/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetDocumentTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "DeleteDocumentTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "PutDocumentTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-type/import": {
|
|
"post": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "PostDocumentTypeImport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportDocumentTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/document-type": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetItemDocumentType",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/document-type/search": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetItemDocumentTypeSearch",
|
|
"parameters": [
|
|
{
|
|
"name": "query",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "isElement",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedModelDocumentTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document-type/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetTreeDocumentTypeAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document-type/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetTreeDocumentTypeChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDocumentTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document-type/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetTreeDocumentTypeRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDocumentTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document-type/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Type"
|
|
],
|
|
"operationId": "GetTreeDocumentTypeSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "target",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetDocumentTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-version": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Version"
|
|
],
|
|
"operationId": "GetDocumentVersion",
|
|
"parameters": [
|
|
{
|
|
"name": "documentId",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "culture",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDocumentVersionItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-version/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Document Version"
|
|
],
|
|
"operationId": "GetDocumentVersionById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVersionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-version/{id}/prevent-cleanup": {
|
|
"put": {
|
|
"tags": [
|
|
"Document Version"
|
|
],
|
|
"operationId": "PutDocumentVersionByIdPreventCleanup",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "preventCleanup",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document-version/{id}/rollback": {
|
|
"post": {
|
|
"tags": [
|
|
"Document Version"
|
|
],
|
|
"operationId": "PostDocumentVersionByIdRollback",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "culture",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/collection/document/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetCollectionDocumentById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"default": "updateDate"
|
|
}
|
|
},
|
|
{
|
|
"name": "orderCulture",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "orderDirection",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DirectionModel"
|
|
}
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDocumentCollectionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document": {
|
|
"post": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PostDocument",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "DeleteDocumentById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutDocumentById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/audit-log": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentByIdAuditLog",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "orderDirection",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DirectionModel"
|
|
}
|
|
},
|
|
{
|
|
"name": "sinceDate",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedAuditLogResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/available-segment-options": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentByIdAvailableSegmentOptions",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedSegmentResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/copy": {
|
|
"post": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PostDocumentByIdCopy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/domains": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentByIdDomains",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DomainsResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutDocumentByIdDomains",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDomainsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDomainsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDomainsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/move": {
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutDocumentByIdMove",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/move-to-recycle-bin": {
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutDocumentByIdMoveToRecycleBin",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/notifications": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentByIdNotifications",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentNotificationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutDocumentByIdNotifications",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentNotificationsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentNotificationsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentNotificationsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/preview-url": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentByIdPreviewUrl",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "providerAlias",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "culture",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "segment",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentUrlInfoModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/public-access": {
|
|
"post": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PostDocumentByIdPublicAccess",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublicAccessRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublicAccessRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublicAccessRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "DeleteDocumentByIdPublicAccess",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentByIdPublicAccess",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublicAccessResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutDocumentByIdPublicAccess",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublicAccessRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublicAccessRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublicAccessRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/publish": {
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutDocumentByIdPublish",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublishDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublishDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublishDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/publish-with-descendants": {
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutDocumentByIdPublishWithDescendants",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublishDocumentWithDescendantsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublishDocumentWithDescendantsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublishDocumentWithDescendantsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublishWithDescendantsResultModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/publish-with-descendants/result/{taskId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentByIdPublishWithDescendantsResultByTaskId",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "taskId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublishWithDescendantsResultModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/published": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentByIdPublished",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PublishedDocumentResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/referenced-by": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentByIdReferencedBy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/referenced-descendants": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentByIdReferencedDescendants",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/{id}/unpublish": {
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutDocumentByIdUnpublish",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UnpublishDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UnpublishDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UnpublishDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1.1/document/{id}/validate": {
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutUmbracoManagementApiV1.1DocumentByIdValidate1.1",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ValidateUpdateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ValidateUpdateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ValidateUpdateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/are-referenced": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentAreReferenced",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/sort": {
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutDocumentSort",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SortingRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SortingRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SortingRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/urls": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetDocumentUrls",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentUrlInfoResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/document/validate": {
|
|
"post": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PostDocumentValidate",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/document": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetItemDocument",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/document/search": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetItemDocumentSearch",
|
|
"parameters": [
|
|
{
|
|
"name": "query",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "trashed",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"name": "culture",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "allowedDocumentTypes",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedModelDocumentItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/document": {
|
|
"delete": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "DeleteRecycleBinDocument",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/document/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "DeleteRecycleBinDocumentById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/document/{id}/original-parent": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetRecycleBinDocumentByIdOriginalParent",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/document/{id}/restore": {
|
|
"put": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "PutRecycleBinDocumentByIdRestore",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/document/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetRecycleBinDocumentChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDocumentRecycleBinItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/document/referenced-by": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetRecycleBinDocumentReferencedBy",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/document/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetRecycleBinDocumentRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDocumentRecycleBinItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/document/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetRecycleBinDocumentSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "target",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetDocumentRecycleBinItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetTreeDocumentAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetTreeDocumentChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDocumentTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetTreeDocumentRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedDocumentTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/document/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Document"
|
|
],
|
|
"operationId": "GetTreeDocumentSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "target",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetDocumentTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/dynamic-root/query": {
|
|
"post": {
|
|
"tags": [
|
|
"Dynamic Root"
|
|
],
|
|
"operationId": "PostDynamicRootQuery",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DynamicRootRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DynamicRootRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DynamicRootRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DynamicRootResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/dynamic-root/steps": {
|
|
"get": {
|
|
"tags": [
|
|
"Dynamic Root"
|
|
],
|
|
"operationId": "GetDynamicRootSteps",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/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": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedHealthCheckGroupResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/health-check-group/{name}": {
|
|
"get": {
|
|
"tags": [
|
|
"Health Check"
|
|
],
|
|
"operationId": "GetHealthCheckGroupByName",
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthCheckGroupPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/health-check-group/{name}/check": {
|
|
"post": {
|
|
"tags": [
|
|
"Health Check"
|
|
],
|
|
"operationId": "PostHealthCheckGroupByNameCheck",
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthCheckGroupWithResultResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/health-check/execute-action": {
|
|
"post": {
|
|
"tags": [
|
|
"Health Check"
|
|
],
|
|
"operationId": "PostHealthCheckExecuteAction",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthCheckActionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthCheckActionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthCheckActionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthCheckResultResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/help": {
|
|
"get": {
|
|
"tags": [
|
|
"Help"
|
|
],
|
|
"operationId": "GetHelp",
|
|
"parameters": [
|
|
{
|
|
"name": "section",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tree",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "baseUrl",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"default": "https://our.umbraco.com"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedHelpPageResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/imaging/resize/urls": {
|
|
"get": {
|
|
"tags": [
|
|
"Imaging"
|
|
],
|
|
"operationId": "GetImagingResizeUrls",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "height",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 200
|
|
}
|
|
},
|
|
{
|
|
"name": "width",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 200
|
|
}
|
|
},
|
|
{
|
|
"name": "mode",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ImageCropModeModel"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaUrlInfoResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/import/analyze": {
|
|
"get": {
|
|
"tags": [
|
|
"Import"
|
|
],
|
|
"operationId": "GetImportAnalyze",
|
|
"parameters": [
|
|
{
|
|
"name": "temporaryFileId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EntityImportAnalysisResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/indexer": {
|
|
"get": {
|
|
"tags": [
|
|
"Indexer"
|
|
],
|
|
"operationId": "GetIndexer",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedIndexResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/indexer/{indexName}": {
|
|
"get": {
|
|
"tags": [
|
|
"Indexer"
|
|
],
|
|
"operationId": "GetIndexerByIndexName",
|
|
"parameters": [
|
|
{
|
|
"name": "indexName",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/IndexResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/indexer/{indexName}/rebuild": {
|
|
"post": {
|
|
"tags": [
|
|
"Indexer"
|
|
],
|
|
"operationId": "PostIndexerByIndexNameRebuild",
|
|
"parameters": [
|
|
{
|
|
"name": "indexName",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/install/settings": {
|
|
"get": {
|
|
"tags": [
|
|
"Install"
|
|
],
|
|
"operationId": "GetInstallSettings",
|
|
"responses": {
|
|
"428": {
|
|
"description": "Precondition Required",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InstallSettingsResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/install/setup": {
|
|
"post": {
|
|
"tags": [
|
|
"Install"
|
|
],
|
|
"operationId": "PostInstallSetup",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InstallRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InstallRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InstallRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"428": {
|
|
"description": "Precondition Required",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/install/validate-database": {
|
|
"post": {
|
|
"tags": [
|
|
"Install"
|
|
],
|
|
"operationId": "PostInstallValidateDatabase",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DatabaseInstallRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DatabaseInstallRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DatabaseInstallRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/language": {
|
|
"get": {
|
|
"tags": [
|
|
"Language"
|
|
],
|
|
"operationId": "GetItemLanguage",
|
|
"parameters": [
|
|
{
|
|
"name": "isoCode",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LanguageItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/language/default": {
|
|
"get": {
|
|
"tags": [
|
|
"Language"
|
|
],
|
|
"operationId": "GetItemLanguageDefault",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LanguageItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/language": {
|
|
"get": {
|
|
"tags": [
|
|
"Language"
|
|
],
|
|
"operationId": "GetLanguage",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedLanguageResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Language"
|
|
],
|
|
"operationId": "PostLanguage",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateLanguageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateLanguageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateLanguageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/language/{isoCode}": {
|
|
"get": {
|
|
"tags": [
|
|
"Language"
|
|
],
|
|
"operationId": "GetLanguageByIsoCode",
|
|
"parameters": [
|
|
{
|
|
"name": "isoCode",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LanguageResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Language"
|
|
],
|
|
"operationId": "DeleteLanguageByIsoCode",
|
|
"parameters": [
|
|
{
|
|
"name": "isoCode",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Language"
|
|
],
|
|
"operationId": "PutLanguageByIsoCode",
|
|
"parameters": [
|
|
{
|
|
"name": "isoCode",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateLanguageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateLanguageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateLanguageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/log-viewer/level": {
|
|
"get": {
|
|
"tags": [
|
|
"Log Viewer"
|
|
],
|
|
"operationId": "GetLogViewerLevel",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedLoggerResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/log-viewer/level-count": {
|
|
"get": {
|
|
"tags": [
|
|
"Log Viewer"
|
|
],
|
|
"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": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LogLevelCountsReponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/log-viewer/log": {
|
|
"get": {
|
|
"tags": [
|
|
"Log Viewer"
|
|
],
|
|
"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": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedLogMessageResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/log-viewer/message-template": {
|
|
"get": {
|
|
"tags": [
|
|
"Log Viewer"
|
|
],
|
|
"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": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedLogTemplateResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/log-viewer/saved-search": {
|
|
"get": {
|
|
"tags": [
|
|
"Log Viewer"
|
|
],
|
|
"operationId": "GetLogViewerSavedSearch",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedSavedLogSearchResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Log Viewer"
|
|
],
|
|
"operationId": "PostLogViewerSavedSearch",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SavedLogSearchRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SavedLogSearchRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SavedLogSearchRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/log-viewer/saved-search/{name}": {
|
|
"get": {
|
|
"tags": [
|
|
"Log Viewer"
|
|
],
|
|
"operationId": "GetLogViewerSavedSearchByName",
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SavedLogSearchResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Log Viewer"
|
|
],
|
|
"operationId": "DeleteLogViewerSavedSearchByName",
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/log-viewer/validate-logs-size": {
|
|
"get": {
|
|
"tags": [
|
|
"Log Viewer"
|
|
],
|
|
"operationId": "GetLogViewerValidateLogsSize",
|
|
"parameters": [
|
|
{
|
|
"name": "startDate",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"name": "endDate",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK"
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/manifest/manifest": {
|
|
"get": {
|
|
"tags": [
|
|
"Manifest"
|
|
],
|
|
"operationId": "GetManifestManifest",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ManifestResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/manifest/manifest/private": {
|
|
"get": {
|
|
"tags": [
|
|
"Manifest"
|
|
],
|
|
"operationId": "GetManifestManifestPrivate",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ManifestResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/manifest/manifest/public": {
|
|
"get": {
|
|
"tags": [
|
|
"Manifest"
|
|
],
|
|
"operationId": "GetManifestManifestPublic",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ManifestResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/media-type": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetItemMediaType",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/media-type/allowed": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetItemMediaTypeAllowed",
|
|
"parameters": [
|
|
{
|
|
"name": "fileExtension",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedModelMediaTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/media-type/folders": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetItemMediaTypeFolders",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedModelMediaTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/media-type/search": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetItemMediaTypeSearch",
|
|
"parameters": [
|
|
{
|
|
"name": "query",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedModelMediaTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type": {
|
|
"post": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "PostMediaType",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetMediaTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "DeleteMediaTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "PutMediaTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/{id}/allowed-children": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetMediaTypeByIdAllowedChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "parentContentKey",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedAllowedMediaTypeModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/{id}/composition-references": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetMediaTypeByIdCompositionReferences",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeCompositionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/{id}/copy": {
|
|
"post": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "PostMediaTypeByIdCopy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/{id}/export": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetMediaTypeByIdExport",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/{id}/import": {
|
|
"put": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "PutMediaTypeByIdImport",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/{id}/move": {
|
|
"put": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "PutMediaTypeByIdMove",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/allowed-at-root": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetMediaTypeAllowedAtRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedAllowedMediaTypeModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/available-compositions": {
|
|
"post": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "PostMediaTypeAvailableCompositions",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeCompositionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeCompositionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeCompositionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/AvailableMediaTypeCompositionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetMediaTypeConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/folder": {
|
|
"post": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "PostMediaTypeFolder",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/folder/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetMediaTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "DeleteMediaTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "PutMediaTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media-type/import": {
|
|
"post": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "PostMediaTypeImport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMediaTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/media-type/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetTreeMediaTypeAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/media-type/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetTreeMediaTypeChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedMediaTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/media-type/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetTreeMediaTypeRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedMediaTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/media-type/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Media Type"
|
|
],
|
|
"operationId": "GetTreeMediaTypeSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "target",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetMediaTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/collection/media": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetCollectionMedia",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"default": "updateDate"
|
|
}
|
|
},
|
|
{
|
|
"name": "orderDirection",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DirectionModel"
|
|
}
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedMediaCollectionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/media": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetItemMedia",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/media/search": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetItemMediaSearch",
|
|
"parameters": [
|
|
{
|
|
"name": "query",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "trashed",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"name": "culture",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "allowedMediaTypes",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedModelMediaItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media": {
|
|
"post": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "PostMedia",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetMediaById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "DeleteMediaById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "PutMediaById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/{id}/audit-log": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetMediaByIdAuditLog",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "orderDirection",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DirectionModel"
|
|
}
|
|
},
|
|
{
|
|
"name": "sinceDate",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedAuditLogResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/{id}/move": {
|
|
"put": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "PutMediaByIdMove",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/{id}/move-to-recycle-bin": {
|
|
"put": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "PutMediaByIdMoveToRecycleBin",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/{id}/referenced-by": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetMediaByIdReferencedBy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/{id}/referenced-descendants": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetMediaByIdReferencedDescendants",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/{id}/validate": {
|
|
"put": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "PutMediaByIdValidate",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/are-referenced": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetMediaAreReferenced",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetMediaConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/sort": {
|
|
"put": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "PutMediaSort",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SortingRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SortingRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SortingRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/urls": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetMediaUrls",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaUrlInfoResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/media/validate": {
|
|
"post": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "PostMediaValidate",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/media": {
|
|
"delete": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "DeleteRecycleBinMedia",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/media/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "DeleteRecycleBinMediaById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/media/{id}/original-parent": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetRecycleBinMediaByIdOriginalParent",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/media/{id}/restore": {
|
|
"put": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "PutRecycleBinMediaByIdRestore",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMediaRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/media/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetRecycleBinMediaChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedMediaRecycleBinItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/media/referenced-by": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetRecycleBinMediaReferencedBy",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/media/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetRecycleBinMediaRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedMediaRecycleBinItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/recycle-bin/media/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetRecycleBinMediaSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "target",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetMediaRecycleBinItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/media/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetTreeMediaAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/media/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetTreeMediaChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedMediaTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/media/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetTreeMediaRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedMediaTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/media/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Media"
|
|
],
|
|
"operationId": "GetTreeMediaSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "target",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "dataTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetMediaTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/member-group": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Group"
|
|
],
|
|
"operationId": "GetItemMemberGroup",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberGroupItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-group": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Group"
|
|
],
|
|
"operationId": "GetMemberGroup",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedMemberGroupResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Member Group"
|
|
],
|
|
"operationId": "PostMemberGroup",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-group/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Group"
|
|
],
|
|
"operationId": "GetMemberGroupById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberGroupResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Member Group"
|
|
],
|
|
"operationId": "DeleteMemberGroupById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Member Group"
|
|
],
|
|
"operationId": "PutMemberGroupById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/member-group/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Group"
|
|
],
|
|
"operationId": "GetTreeMemberGroupRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedNamedEntityTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/member-type": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "GetItemMemberType",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/member-type/search": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "GetItemMemberTypeSearch",
|
|
"parameters": [
|
|
{
|
|
"name": "query",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedModelMemberTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type": {
|
|
"post": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "PostMemberType",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "GetMemberTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "DeleteMemberTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "PutMemberTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type/{id}/composition-references": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "GetMemberTypeByIdCompositionReferences",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeCompositionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type/{id}/copy": {
|
|
"post": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "PostMemberTypeByIdCopy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CopyMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type/{id}/export": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "GetMemberTypeByIdExport",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type/{id}/import": {
|
|
"put": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "PutMemberTypeByIdImport",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type/{id}/move": {
|
|
"put": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "PutMemberTypeByIdMove",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MoveMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type/available-compositions": {
|
|
"post": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "PostMemberTypeAvailableCompositions",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeCompositionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeCompositionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeCompositionRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/AvailableMemberTypeCompositionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "GetMemberTypeConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type/folder": {
|
|
"post": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "PostMemberTypeFolder",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type/folder/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "GetMemberTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "DeleteMemberTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "PutMemberTypeFolderById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member-type/import": {
|
|
"post": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "PostMemberTypeImport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ImportMemberTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/member-type/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "GetTreeMemberTypeAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/member-type/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "GetTreeMemberTypeChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedMemberTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/member-type/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "GetTreeMemberTypeRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedMemberTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/member-type/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Member Type"
|
|
],
|
|
"operationId": "GetTreeMemberTypeSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "target",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "foldersOnly",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetMemberTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/filter/member": {
|
|
"get": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "GetFilterMember",
|
|
"parameters": [
|
|
{
|
|
"name": "memberTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "memberGroupName",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "isApproved",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"name": "isLockedOut",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"default": "username"
|
|
}
|
|
},
|
|
{
|
|
"name": "orderDirection",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DirectionModel"
|
|
}
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedMemberResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/member": {
|
|
"get": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "GetItemMember",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/member/search": {
|
|
"get": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "GetItemMemberSearch",
|
|
"parameters": [
|
|
{
|
|
"name": "query",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "allowedMemberTypes",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedModelMemberItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member": {
|
|
"post": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "PostMember",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "GetMemberById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "DeleteMemberById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "PutMemberById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member/{id}/referenced-by": {
|
|
"get": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "GetMemberByIdReferencedBy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedIReferenceResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member/{id}/referenced-descendants": {
|
|
"get": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "GetMemberByIdReferencedDescendants",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member/{id}/validate": {
|
|
"put": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "PutMemberByIdValidate",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member/are-referenced": {
|
|
"get": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "GetMemberAreReferenced",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 20
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "GetMemberConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/member/validate": {
|
|
"post": {
|
|
"tags": [
|
|
"Member"
|
|
],
|
|
"operationId": "PostMemberValidate",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/models-builder/build": {
|
|
"post": {
|
|
"tags": [
|
|
"Models Builder"
|
|
],
|
|
"operationId": "PostModelsBuilderBuild",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"428": {
|
|
"description": "Precondition Required",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/models-builder/dashboard": {
|
|
"get": {
|
|
"tags": [
|
|
"Models Builder"
|
|
],
|
|
"operationId": "GetModelsBuilderDashboard",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ModelsBuilderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/models-builder/status": {
|
|
"get": {
|
|
"tags": [
|
|
"Models Builder"
|
|
],
|
|
"operationId": "GetModelsBuilderStatus",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OutOfDateStatusResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/news-dashboard": {
|
|
"get": {
|
|
"tags": [
|
|
"News Dashboard"
|
|
],
|
|
"operationId": "GetNewsDashboard",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/NewsDashboardResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/object-types": {
|
|
"get": {
|
|
"tags": [
|
|
"Object Types"
|
|
],
|
|
"operationId": "GetObjectTypes",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedObjectTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/oembed/query": {
|
|
"get": {
|
|
"tags": [
|
|
"oEmbed"
|
|
],
|
|
"operationId": "GetOembedQuery",
|
|
"parameters": [
|
|
{
|
|
"name": "url",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
{
|
|
"name": "maxWidth",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "maxHeight",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/OEmbedResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/package/{name}/run-migration": {
|
|
"post": {
|
|
"tags": [
|
|
"Package"
|
|
],
|
|
"operationId": "PostPackageByNameRunMigration",
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/package/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Package"
|
|
],
|
|
"operationId": "GetPackageConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PackageConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/package/created": {
|
|
"get": {
|
|
"tags": [
|
|
"Package"
|
|
],
|
|
"operationId": "GetPackageCreated",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedPackageDefinitionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Package"
|
|
],
|
|
"operationId": "PostPackageCreated",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreatePackageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreatePackageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreatePackageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/package/created/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Package"
|
|
],
|
|
"operationId": "GetPackageCreatedById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PackageDefinitionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Package"
|
|
],
|
|
"operationId": "DeletePackageCreatedById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Package"
|
|
],
|
|
"operationId": "PutPackageCreatedById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdatePackageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdatePackageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdatePackageRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/package/created/{id}/download": {
|
|
"get": {
|
|
"tags": [
|
|
"Package"
|
|
],
|
|
"operationId": "GetPackageCreatedByIdDownload",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/package/migration-status": {
|
|
"get": {
|
|
"tags": [
|
|
"Package"
|
|
],
|
|
"operationId": "GetPackageMigrationStatus",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedPackageMigrationStatusResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/partial-view": {
|
|
"get": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "GetItemPartialView",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PartialViewItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/partial-view": {
|
|
"post": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "PostPartialView",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreatePartialViewRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreatePartialViewRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreatePartialViewRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/partial-view/{path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "GetPartialViewByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PartialViewResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "DeletePartialViewByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "PutPartialViewByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdatePartialViewRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdatePartialViewRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdatePartialViewRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/partial-view/{path}/rename": {
|
|
"put": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "PutPartialViewByPathRename",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RenamePartialViewRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RenamePartialViewRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RenamePartialViewRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/partial-view/folder": {
|
|
"post": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "PostPartialViewFolder",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreatePartialViewFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreatePartialViewFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreatePartialViewFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/partial-view/folder/{path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "GetPartialViewFolderByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PartialViewFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "DeletePartialViewFolderByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/partial-view/snippet": {
|
|
"get": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "GetPartialViewSnippet",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedPartialViewSnippetItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/partial-view/snippet/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "GetPartialViewSnippetById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PartialViewSnippetResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/partial-view/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "GetTreePartialViewAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantPath",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/partial-view/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "GetTreePartialViewChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentPath",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/partial-view/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "GetTreePartialViewRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/partial-view/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Partial View"
|
|
],
|
|
"operationId": "GetTreePartialViewSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetFileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/preview": {
|
|
"delete": {
|
|
"tags": [
|
|
"Preview"
|
|
],
|
|
"operationId": "DeletePreview",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Preview"
|
|
],
|
|
"operationId": "PostPreview",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/profiling/status": {
|
|
"get": {
|
|
"tags": [
|
|
"Profiling"
|
|
],
|
|
"operationId": "GetProfilingStatus",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProfilingStatusResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Profiling"
|
|
],
|
|
"operationId": "PutProfilingStatus",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProfilingStatusRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProfilingStatusRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProfilingStatusRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/property-type/is-used": {
|
|
"get": {
|
|
"tags": [
|
|
"Property Type"
|
|
],
|
|
"operationId": "GetPropertyTypeIsUsed",
|
|
"parameters": [
|
|
{
|
|
"name": "contentTypeId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "propertyAlias",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/published-cache/rebuild": {
|
|
"post": {
|
|
"tags": [
|
|
"Published Cache"
|
|
],
|
|
"operationId": "PostPublishedCacheRebuild",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/published-cache/rebuild/status": {
|
|
"get": {
|
|
"tags": [
|
|
"Published Cache"
|
|
],
|
|
"operationId": "GetPublishedCacheRebuildStatus",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RebuildStatusModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/published-cache/reload": {
|
|
"post": {
|
|
"tags": [
|
|
"Published Cache"
|
|
],
|
|
"operationId": "PostPublishedCacheReload",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/redirect-management": {
|
|
"get": {
|
|
"tags": [
|
|
"Redirect Management"
|
|
],
|
|
"operationId": "GetRedirectManagement",
|
|
"parameters": [
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedRedirectUrlResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/redirect-management/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Redirect Management"
|
|
],
|
|
"operationId": "GetRedirectManagementById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedRedirectUrlResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Redirect Management"
|
|
],
|
|
"operationId": "DeleteRedirectManagementById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/redirect-management/status": {
|
|
"get": {
|
|
"tags": [
|
|
"Redirect Management"
|
|
],
|
|
"operationId": "GetRedirectManagementStatus",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RedirectUrlStatusResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Redirect Management"
|
|
],
|
|
"operationId": "PostRedirectManagementStatus",
|
|
"parameters": [
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RedirectStatusModel"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/relation-type": {
|
|
"get": {
|
|
"tags": [
|
|
"Relation Type"
|
|
],
|
|
"operationId": "GetItemRelationType",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RelationTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/relation-type": {
|
|
"get": {
|
|
"tags": [
|
|
"Relation Type"
|
|
],
|
|
"operationId": "GetRelationType",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedRelationTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/relation-type/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Relation Type"
|
|
],
|
|
"operationId": "GetRelationTypeById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RelationTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/relation/type/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Relation"
|
|
],
|
|
"operationId": "GetRelationByRelationTypeId",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedRelationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedProblemDetailsModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/script": {
|
|
"get": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "GetItemScript",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ScriptItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/script": {
|
|
"post": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "PostScript",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateScriptRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateScriptRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateScriptRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/script/{path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "GetScriptByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ScriptResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "DeleteScriptByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "PutScriptByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateScriptRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateScriptRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateScriptRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/script/{path}/rename": {
|
|
"put": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "PutScriptByPathRename",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RenameScriptRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RenameScriptRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RenameScriptRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/script/folder": {
|
|
"post": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "PostScriptFolder",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateScriptFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateScriptFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateScriptFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/script/folder/{path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "GetScriptFolderByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ScriptFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "DeleteScriptFolderByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/script/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "GetTreeScriptAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantPath",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/script/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "GetTreeScriptChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentPath",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/script/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "GetTreeScriptRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/script/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Script"
|
|
],
|
|
"operationId": "GetTreeScriptSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetFileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/searcher": {
|
|
"get": {
|
|
"tags": [
|
|
"Searcher"
|
|
],
|
|
"operationId": "GetSearcher",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedSearcherResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/searcher/{searcherName}/query": {
|
|
"get": {
|
|
"tags": [
|
|
"Searcher"
|
|
],
|
|
"operationId": "GetSearcherBySearcherNameQuery",
|
|
"parameters": [
|
|
{
|
|
"name": "searcherName",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "term",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedSearchResultResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/security/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Security"
|
|
],
|
|
"operationId": "GetSecurityConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SecurityConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/security/forgot-password": {
|
|
"post": {
|
|
"tags": [
|
|
"Security"
|
|
],
|
|
"operationId": "PostSecurityForgotPassword",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResetPasswordRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResetPasswordRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResetPasswordRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/security/forgot-password/reset": {
|
|
"post": {
|
|
"tags": [
|
|
"Security"
|
|
],
|
|
"operationId": "PostSecurityForgotPasswordReset",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResetPasswordTokenRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResetPasswordTokenRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResetPasswordTokenRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"204": {
|
|
"description": "No Content",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetailsBuilderModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetailsBuilderModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/security/forgot-password/verify": {
|
|
"post": {
|
|
"tags": [
|
|
"Security"
|
|
],
|
|
"operationId": "PostSecurityForgotPasswordVerify",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VerifyResetPasswordTokenRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VerifyResetPasswordTokenRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VerifyResetPasswordTokenRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VerifyResetPasswordResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetailsBuilderModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetailsBuilderModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/segment": {
|
|
"get": {
|
|
"tags": [
|
|
"Segment"
|
|
],
|
|
"operationId": "GetSegment",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedSegmentResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/server/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Server"
|
|
],
|
|
"operationId": "GetServerConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ServerConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/server/information": {
|
|
"get": {
|
|
"tags": [
|
|
"Server"
|
|
],
|
|
"operationId": "GetServerInformation",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ServerInformationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/server/status": {
|
|
"get": {
|
|
"tags": [
|
|
"Server"
|
|
],
|
|
"operationId": "GetServerStatus",
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ServerStatusResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/server/troubleshooting": {
|
|
"get": {
|
|
"tags": [
|
|
"Server"
|
|
],
|
|
"operationId": "GetServerTroubleshooting",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ServerTroubleshootingResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/server/upgrade-check": {
|
|
"get": {
|
|
"tags": [
|
|
"Server"
|
|
],
|
|
"operationId": "GetServerUpgradeCheck",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpgradeCheckResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"deprecated": true,
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/static-file": {
|
|
"get": {
|
|
"tags": [
|
|
"Static File"
|
|
],
|
|
"operationId": "GetItemStaticFile",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/StaticFileItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/static-file/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Static File"
|
|
],
|
|
"operationId": "GetTreeStaticFileAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantPath",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/static-file/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Static File"
|
|
],
|
|
"operationId": "GetTreeStaticFileChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentPath",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/static-file/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Static File"
|
|
],
|
|
"operationId": "GetTreeStaticFileRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/stylesheet": {
|
|
"get": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "GetItemStylesheet",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/StylesheetItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/stylesheet": {
|
|
"post": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "PostStylesheet",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateStylesheetRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateStylesheetRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateStylesheetRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/stylesheet/{path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "GetStylesheetByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/StylesheetResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "DeleteStylesheetByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "PutStylesheetByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateStylesheetRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateStylesheetRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateStylesheetRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/stylesheet/{path}/rename": {
|
|
"put": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "PutStylesheetByPathRename",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RenameStylesheetRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RenameStylesheetRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RenameStylesheetRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/stylesheet/folder": {
|
|
"post": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "PostStylesheetFolder",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateStylesheetFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateStylesheetFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateStylesheetFolderRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/stylesheet/folder/{path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "GetStylesheetFolderByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/StylesheetFolderResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "DeleteStylesheetFolderByPath",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/stylesheet/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "GetTreeStylesheetAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantPath",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/stylesheet/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "GetTreeStylesheetChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentPath",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/stylesheet/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "GetTreeStylesheetRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedFileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/stylesheet/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Stylesheet"
|
|
],
|
|
"operationId": "GetTreeStylesheetSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "path",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetFileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tag": {
|
|
"get": {
|
|
"tags": [
|
|
"Tag"
|
|
],
|
|
"operationId": "GetTag",
|
|
"parameters": [
|
|
{
|
|
"name": "query",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tagGroup",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "culture",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedTagResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/telemetry": {
|
|
"get": {
|
|
"tags": [
|
|
"Telemetry"
|
|
],
|
|
"operationId": "GetTelemetry",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedTelemetryResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/telemetry/level": {
|
|
"get": {
|
|
"tags": [
|
|
"Telemetry"
|
|
],
|
|
"operationId": "GetTelemetryLevel",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TelemetryResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Telemetry"
|
|
],
|
|
"operationId": "PostTelemetryLevel",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TelemetryRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TelemetryRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TelemetryRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "GetItemTemplate",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/template/search": {
|
|
"get": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "GetItemTemplateSearch",
|
|
"parameters": [
|
|
{
|
|
"name": "query",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedModelTemplateItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/template": {
|
|
"post": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "PostTemplate",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateTemplateRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateTemplateRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateTemplateRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/template/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "GetTemplateById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "DeleteTemplateById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "PutTemplateById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateTemplateRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateTemplateRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateTemplateRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/template/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "GetTemplateConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/template/query/execute": {
|
|
"post": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "PostTemplateQueryExecute",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateQueryExecuteModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateQueryExecuteModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateQueryExecuteModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateQueryResultResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/template/query/settings": {
|
|
"get": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "GetTemplateQuerySettings",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateQuerySettingsResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/template/ancestors": {
|
|
"get": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "GetTreeTemplateAncestors",
|
|
"parameters": [
|
|
{
|
|
"name": "descendantId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/NamedEntityTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/template/children": {
|
|
"get": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "GetTreeTemplateChildren",
|
|
"parameters": [
|
|
{
|
|
"name": "parentId",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedNamedEntityTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/template/root": {
|
|
"get": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "GetTreeTemplateRoot",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedNamedEntityTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/tree/template/siblings": {
|
|
"get": {
|
|
"tags": [
|
|
"Template"
|
|
],
|
|
"operationId": "GetTreeTemplateSiblings",
|
|
"parameters": [
|
|
{
|
|
"name": "target",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "before",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
{
|
|
"name": "after",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SubsetNamedEntityTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/temporary-file": {
|
|
"post": {
|
|
"tags": [
|
|
"Temporary File"
|
|
],
|
|
"operationId": "PostTemporaryFile",
|
|
"requestBody": {
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"required": [
|
|
"File",
|
|
"Id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"Id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"File": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
},
|
|
"encoding": {
|
|
"Id": {
|
|
"style": "form"
|
|
},
|
|
"File": {
|
|
"style": "form"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/temporary-file/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Temporary File"
|
|
],
|
|
"operationId": "GetTemporaryFileById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemporaryFileResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Temporary File"
|
|
],
|
|
"operationId": "DeleteTemporaryFileById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/temporary-file/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"Temporary File"
|
|
],
|
|
"operationId": "GetTemporaryFileConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemporaryFileConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/upgrade/authorize": {
|
|
"post": {
|
|
"tags": [
|
|
"Upgrade"
|
|
],
|
|
"operationId": "PostUpgradeAuthorize",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"428": {
|
|
"description": "Precondition Required",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/upgrade/settings": {
|
|
"get": {
|
|
"tags": [
|
|
"Upgrade"
|
|
],
|
|
"operationId": "GetUpgradeSettings",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpgradeSettingsResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"428": {
|
|
"description": "Precondition Required",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user-data": {
|
|
"post": {
|
|
"tags": [
|
|
"User Data"
|
|
],
|
|
"operationId": "PostUserData",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserDataRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserDataRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserDataRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UserDataOperationStatusModel"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UserDataOperationStatusModel"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"User Data"
|
|
],
|
|
"operationId": "GetUserData",
|
|
"parameters": [
|
|
{
|
|
"name": "groups",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "identifiers",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedUserDataResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"User Data"
|
|
],
|
|
"operationId": "PutUserData",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserDataRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserDataRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserDataRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UserDataOperationStatusModel"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UserDataOperationStatusModel"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user-data/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"User Data"
|
|
],
|
|
"operationId": "GetUserDataById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserDataModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"User Data"
|
|
],
|
|
"operationId": "DeleteUserDataById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UserDataOperationStatusModel"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UserDataOperationStatusModel"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/filter/user-group": {
|
|
"get": {
|
|
"tags": [
|
|
"User Group"
|
|
],
|
|
"operationId": "GetFilterUserGroup",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedUserGroupResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/user-group": {
|
|
"get": {
|
|
"tags": [
|
|
"User Group"
|
|
],
|
|
"operationId": "GetItemUserGroup",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserGroupItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user-group": {
|
|
"delete": {
|
|
"tags": [
|
|
"User Group"
|
|
],
|
|
"operationId": "DeleteUserGroup",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DeleteUserGroupsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DeleteUserGroupsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DeleteUserGroupsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"User Group"
|
|
],
|
|
"operationId": "PostUserGroup",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"User Group"
|
|
],
|
|
"operationId": "GetUserGroup",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedUserGroupResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user-group/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"User Group"
|
|
],
|
|
"operationId": "GetUserGroupById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserGroupResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"User Group"
|
|
],
|
|
"operationId": "DeleteUserGroupById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"User Group"
|
|
],
|
|
"operationId": "PutUserGroupById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserGroupRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user-group/{id}/users": {
|
|
"delete": {
|
|
"tags": [
|
|
"User Group"
|
|
],
|
|
"operationId": "DeleteUserGroupByIdUsers",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"User Group"
|
|
],
|
|
"operationId": "PostUserGroupByIdUsers",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/filter/user": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetFilterUser",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UserOrderModel"
|
|
}
|
|
},
|
|
{
|
|
"name": "orderDirection",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DirectionModel"
|
|
}
|
|
},
|
|
{
|
|
"name": "userGroupIds",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "userStates",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/UserStateModel"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedUserResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/user": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetItemUser",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUser",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "DeleteUser",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DeleteUsersRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DeleteUsersRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DeleteUsersRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUser",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedUserResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "DeleteUserById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PutUserById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/{id}/2fa": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserById2fa",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserTwoFactorProviderModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/{id}/2fa/{providerName}": {
|
|
"delete": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "DeleteUserById2faByProviderName",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "providerName",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/{id}/calculate-start-nodes": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserByIdCalculateStartNodes",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CalculatedUserStartNodesResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/{id}/change-password": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserByIdChangePassword",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ChangePasswordUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ChangePasswordUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ChangePasswordUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/{id}/client-credentials": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserByIdClientCredentials",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserClientCredentialsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserClientCredentialsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateUserClientCredentialsRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserByIdClientCredentials",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/{id}/client-credentials/{clientId}": {
|
|
"delete": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "DeleteUserByIdClientCredentialsByClientId",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/{id}/reset-password": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserByIdResetPassword",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResetPasswordUserResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/avatar/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "DeleteUserAvatarById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserAvatarById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SetAvatarRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SetAvatarRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SetAvatarRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/current": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserCurrent",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CurrentUserResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/current/2fa": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserCurrent2fa",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserTwoFactorProviderModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/current/2fa/{providerName}": {
|
|
"delete": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "DeleteUserCurrent2faByProviderName",
|
|
"parameters": [
|
|
{
|
|
"name": "providerName",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "code",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserCurrent2faByProviderName",
|
|
"parameters": [
|
|
{
|
|
"name": "providerName",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnableTwoFactorRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnableTwoFactorRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnableTwoFactorRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/NoopSetupTwoFactorModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserCurrent2faByProviderName",
|
|
"parameters": [
|
|
{
|
|
"name": "providerName",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/NoopSetupTwoFactorModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/current/avatar": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserCurrentAvatar",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SetAvatarRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SetAvatarRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SetAvatarRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/current/change-password": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserCurrentChangePassword",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ChangePasswordCurrentUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ChangePasswordCurrentUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ChangePasswordCurrentUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/current/configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserCurrentConfiguration",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CurrentUserConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/current/login-providers": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserCurrentLoginProviders",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserExternalLoginProviderModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/current/permissions": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserCurrentPermissions",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserPermissionsResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/current/permissions/document": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserCurrentPermissionsDocument",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserPermissionsResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/current/permissions/media": {
|
|
"get": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "GetUserCurrentPermissionsMedia",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserPermissionsResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/disable": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserDisable",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DisableUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DisableUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DisableUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/enable": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserEnable",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnableUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnableUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/EnableUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/invite": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserInvite",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InviteUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InviteUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/InviteUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/invite/create-password": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserInviteCreatePassword",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateInitialPasswordUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateInitialPasswordUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateInitialPasswordUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/invite/resend": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserInviteResend",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResendInviteUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResendInviteUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ResendInviteUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/invite/verify": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserInviteVerify",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VerifyInviteUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VerifyInviteUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VerifyInviteUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VerifyInviteUserResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/set-user-groups": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserSetUserGroups",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserGroupsOnUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserGroupsOnUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateUserGroupsOnUserRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/user/unlock": {
|
|
"post": {
|
|
"tags": [
|
|
"User"
|
|
],
|
|
"operationId": "PostUserUnlock",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UnlockUsersRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UnlockUsersRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UnlockUsersRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/item/webhook": {
|
|
"get": {
|
|
"tags": [
|
|
"Webhook"
|
|
],
|
|
"operationId": "GetItemWebhook",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "query",
|
|
"schema": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WebhookItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/webhook": {
|
|
"get": {
|
|
"tags": [
|
|
"Webhook"
|
|
],
|
|
"operationId": "GetWebhook",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedWebhookResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Webhook"
|
|
],
|
|
"operationId": "PostWebhook",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateWebhookRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateWebhookRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateWebhookRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"headers": {
|
|
"Umb-Generated-Resource": {
|
|
"description": "Identifier of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Identifier of the newly created resource"
|
|
}
|
|
},
|
|
"Location": {
|
|
"description": "Location of the newly created resource",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "Location of the newly created resource",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/webhook/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Webhook"
|
|
],
|
|
"operationId": "GetWebhookById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WebhookResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Webhook"
|
|
],
|
|
"operationId": "DeleteWebhookById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Webhook"
|
|
],
|
|
"operationId": "PutWebhookById",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateWebhookRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"text/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateWebhookRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"application/*+json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateWebhookRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"404": {
|
|
"description": "Not Found",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "OK",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource",
|
|
"headers": {
|
|
"Umb-Notifications": {
|
|
"description": "The list of notifications produced during the request.",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/NotificationHeaderModel"
|
|
},
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/webhook/{id}/logs": {
|
|
"get": {
|
|
"tags": [
|
|
"Webhook"
|
|
],
|
|
"operationId": "GetWebhookByIdLogs",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedWebhookLogResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/webhook/events": {
|
|
"get": {
|
|
"tags": [
|
|
"Webhook"
|
|
],
|
|
"operationId": "GetWebhookEvents",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedWebhookEventModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/umbraco/management/api/v1/webhook/logs": {
|
|
"get": {
|
|
"tags": [
|
|
"Webhook"
|
|
],
|
|
"operationId": "GetWebhookLogs",
|
|
"parameters": [
|
|
{
|
|
"name": "skip",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "take",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 100
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PagedWebhookLogResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "The resource is protected and requires an authentication token"
|
|
},
|
|
"403": {
|
|
"description": "The authenticated user does not have access to this resource"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Backoffice-User": [ ]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"AllowedDocumentTypeModel": {
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"AllowedMediaTypeModel": {
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"AuditLogResponseModel": {
|
|
"required": [
|
|
"logType",
|
|
"timestamp",
|
|
"user"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"user": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"timestamp": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"logType": {
|
|
"$ref": "#/components/schemas/AuditTypeModel"
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"parameters": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"AuditTypeModel": {
|
|
"enum": [
|
|
"New",
|
|
"Save",
|
|
"SaveVariant",
|
|
"Open",
|
|
"Delete",
|
|
"Publish",
|
|
"PublishVariant",
|
|
"SendToPublish",
|
|
"SendToPublishVariant",
|
|
"Unpublish",
|
|
"UnpublishVariant",
|
|
"Move",
|
|
"Copy",
|
|
"AssignDomain",
|
|
"PublicAccess",
|
|
"Sort",
|
|
"Notify",
|
|
"System",
|
|
"RollBack",
|
|
"PackagerInstall",
|
|
"PackagerUninstall",
|
|
"Custom",
|
|
"ContentVersionPreventCleanup",
|
|
"ContentVersionEnableCleanup"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"AvailableDocumentTypeCompositionResponseModel": {
|
|
"required": [
|
|
"folderPath",
|
|
"icon",
|
|
"id",
|
|
"isCompatible",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"folderPath": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"isCompatible": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"AvailableMediaTypeCompositionResponseModel": {
|
|
"required": [
|
|
"folderPath",
|
|
"icon",
|
|
"id",
|
|
"isCompatible",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"folderPath": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"isCompatible": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"AvailableMemberTypeCompositionResponseModel": {
|
|
"required": [
|
|
"folderPath",
|
|
"icon",
|
|
"id",
|
|
"isCompatible",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"folderPath": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"isCompatible": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CalculatedUserStartNodesResponseModel": {
|
|
"required": [
|
|
"documentStartNodeIds",
|
|
"hasDocumentRootAccess",
|
|
"hasMediaRootAccess",
|
|
"id",
|
|
"mediaStartNodeIds"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"documentStartNodeIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"hasDocumentRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaStartNodeIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"hasMediaRootAccess": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ChangePasswordCurrentUserRequestModel": {
|
|
"required": [
|
|
"newPassword"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"newPassword": {
|
|
"type": "string"
|
|
},
|
|
"oldPassword": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ChangePasswordUserRequestModel": {
|
|
"required": [
|
|
"newPassword"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"newPassword": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CompositionTypeModel": {
|
|
"enum": [
|
|
"Composition",
|
|
"Inheritance"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"ConsentLevelPresentationModel": {
|
|
"required": [
|
|
"description",
|
|
"level"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"level": {
|
|
"$ref": "#/components/schemas/TelemetryLevelModel"
|
|
},
|
|
"description": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CopyDataTypeRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CopyDocumentRequestModel": {
|
|
"required": [
|
|
"includeDescendants",
|
|
"relateToOriginal"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"relateToOriginal": {
|
|
"type": "boolean"
|
|
},
|
|
"includeDescendants": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CopyDocumentTypeRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CopyMediaTypeRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CopyMemberTypeRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateDataTypeRequestModel": {
|
|
"required": [
|
|
"editorAlias",
|
|
"editorUiAlias",
|
|
"name",
|
|
"values"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"editorAlias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"editorUiAlias": {
|
|
"type": "string"
|
|
},
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DataTypePropertyPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateDictionaryItemRequestModel": {
|
|
"required": [
|
|
"name",
|
|
"translations"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"translations": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DictionaryItemTranslationModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateDocumentBlueprintFromDocumentRequestModel": {
|
|
"required": [
|
|
"document",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"document": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateDocumentBlueprintRequestModel": {
|
|
"required": [
|
|
"documentType",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentValueModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateDocumentRequestModel": {
|
|
"required": [
|
|
"documentType",
|
|
"template",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentValueModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"template": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateDocumentTypePropertyTypeContainerRequestModel": {
|
|
"required": [
|
|
"id",
|
|
"sortOrder",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateDocumentTypePropertyTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"appearance",
|
|
"dataType",
|
|
"id",
|
|
"name",
|
|
"sortOrder",
|
|
"validation",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"container": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"dataType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"validation": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeValidationModel"
|
|
}
|
|
]
|
|
},
|
|
"appearance": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateDocumentTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"allowedAsRoot",
|
|
"allowedDocumentTypes",
|
|
"allowedTemplates",
|
|
"cleanup",
|
|
"compositions",
|
|
"containers",
|
|
"icon",
|
|
"isElement",
|
|
"name",
|
|
"properties",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"allowedAsRoot": {
|
|
"type": "boolean"
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
},
|
|
"properties": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentTypePropertyTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"containers": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateDocumentTypePropertyTypeContainerRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"allowedTemplates": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultTemplate": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"cleanup": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeCleanupModel"
|
|
}
|
|
]
|
|
},
|
|
"allowedDocumentTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeSortModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"compositions": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeCompositionModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateFolderRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateInitialPasswordUserRequestModel": {
|
|
"required": [
|
|
"password",
|
|
"token",
|
|
"user"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"user": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"token": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateLanguageRequestModel": {
|
|
"required": [
|
|
"isDefault",
|
|
"isMandatory",
|
|
"isoCode",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"isDefault": {
|
|
"type": "boolean"
|
|
},
|
|
"isMandatory": {
|
|
"type": "boolean"
|
|
},
|
|
"fallbackIsoCode": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"isoCode": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateMediaRequestModel": {
|
|
"required": [
|
|
"mediaType",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaValueModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaVariantRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"mediaType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateMediaTypePropertyTypeContainerRequestModel": {
|
|
"required": [
|
|
"id",
|
|
"sortOrder",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateMediaTypePropertyTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"appearance",
|
|
"dataType",
|
|
"id",
|
|
"name",
|
|
"sortOrder",
|
|
"validation",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"container": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"dataType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"validation": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeValidationModel"
|
|
}
|
|
]
|
|
},
|
|
"appearance": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateMediaTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"allowedAsRoot",
|
|
"allowedMediaTypes",
|
|
"compositions",
|
|
"containers",
|
|
"icon",
|
|
"isElement",
|
|
"name",
|
|
"properties",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"allowedAsRoot": {
|
|
"type": "boolean"
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
},
|
|
"properties": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMediaTypePropertyTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"containers": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMediaTypePropertyTypeContainerRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"allowedMediaTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeSortModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"compositions": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeCompositionModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateMemberGroupRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateMemberRequestModel": {
|
|
"required": [
|
|
"email",
|
|
"isApproved",
|
|
"memberType",
|
|
"password",
|
|
"username",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberValueModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberVariantRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
},
|
|
"memberType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"nullable": true
|
|
},
|
|
"isApproved": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateMemberTypePropertyTypeContainerRequestModel": {
|
|
"required": [
|
|
"id",
|
|
"sortOrder",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateMemberTypePropertyTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"appearance",
|
|
"dataType",
|
|
"id",
|
|
"isSensitive",
|
|
"name",
|
|
"sortOrder",
|
|
"validation",
|
|
"variesByCulture",
|
|
"variesBySegment",
|
|
"visibility"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"container": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"dataType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"validation": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeValidationModel"
|
|
}
|
|
]
|
|
},
|
|
"appearance": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
|
|
}
|
|
]
|
|
},
|
|
"isSensitive": {
|
|
"type": "boolean"
|
|
},
|
|
"visibility": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypePropertyTypeVisibilityModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateMemberTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"allowedAsRoot",
|
|
"compositions",
|
|
"containers",
|
|
"icon",
|
|
"isElement",
|
|
"name",
|
|
"properties",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"allowedAsRoot": {
|
|
"type": "boolean"
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
},
|
|
"properties": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberTypePropertyTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"containers": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CreateMemberTypePropertyTypeContainerRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"compositions": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeCompositionModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreatePackageRequestModel": {
|
|
"required": [
|
|
"contentLoadChildNodes",
|
|
"dataTypes",
|
|
"dictionaryItems",
|
|
"documentTypes",
|
|
"languages",
|
|
"mediaIds",
|
|
"mediaLoadChildNodes",
|
|
"mediaTypes",
|
|
"name",
|
|
"partialViews",
|
|
"scripts",
|
|
"stylesheets",
|
|
"templates"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"contentNodeId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"contentLoadChildNodes": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"mediaLoadChildNodes": {
|
|
"type": "boolean"
|
|
},
|
|
"documentTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"mediaTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"dataTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"templates": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"partialViews": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"stylesheets": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"scripts": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"languages": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"dictionaryItems": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreatePartialViewFolderRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreatePartialViewRequestModel": {
|
|
"required": [
|
|
"content",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateScriptFolderRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateScriptRequestModel": {
|
|
"required": [
|
|
"content",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateStylesheetFolderRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateStylesheetRequestModel": {
|
|
"required": [
|
|
"content",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateTemplateRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateUserClientCredentialsRequestModel": {
|
|
"required": [
|
|
"clientId",
|
|
"clientSecret"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"clientSecret": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateUserDataRequestModel": {
|
|
"required": [
|
|
"group",
|
|
"identifier",
|
|
"value"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"identifier": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateUserGroupRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"documentRootAccess",
|
|
"fallbackPermissions",
|
|
"hasAccessToAllLanguages",
|
|
"languages",
|
|
"mediaRootAccess",
|
|
"name",
|
|
"permissions",
|
|
"sections"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"sections": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"languages": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"hasAccessToAllLanguages": {
|
|
"type": "boolean"
|
|
},
|
|
"documentStartNode": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"documentRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaStartNode": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"mediaRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"fallbackPermissions": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"permissions": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentPermissionPresentationModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DocumentPropertyValuePermissionPresentationModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UnknownTypePermissionPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateUserRequestModel": {
|
|
"required": [
|
|
"email",
|
|
"kind",
|
|
"name",
|
|
"userGroupIds",
|
|
"userName"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"userName": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"userGroupIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"kind": {
|
|
"$ref": "#/components/schemas/UserKindModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CreateWebhookRequestModel": {
|
|
"required": [
|
|
"contentTypeKeys",
|
|
"enabled",
|
|
"events",
|
|
"headers",
|
|
"url"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"url": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"contentTypeKeys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CultureAndScheduleRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"schedule": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ScheduleRequestModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CultureReponseModel": {
|
|
"required": [
|
|
"englishName",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"englishName": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CurrentUserConfigurationResponseModel": {
|
|
"required": [
|
|
"allowChangePassword",
|
|
"allowTwoFactor",
|
|
"keepUserLoggedIn",
|
|
"passwordConfiguration"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"keepUserLoggedIn": {
|
|
"type": "boolean"
|
|
},
|
|
"passwordConfiguration": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PasswordConfigurationResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"allowChangePassword": {
|
|
"type": "boolean"
|
|
},
|
|
"allowTwoFactor": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"CurrentUserResponseModel": {
|
|
"required": [
|
|
"allowedSections",
|
|
"avatarUrls",
|
|
"documentStartNodeIds",
|
|
"email",
|
|
"fallbackPermissions",
|
|
"hasAccessToAllLanguages",
|
|
"hasAccessToSensitiveData",
|
|
"hasDocumentRootAccess",
|
|
"hasMediaRootAccess",
|
|
"id",
|
|
"isAdmin",
|
|
"languageIsoCode",
|
|
"languages",
|
|
"mediaStartNodeIds",
|
|
"name",
|
|
"permissions",
|
|
"userGroupIds",
|
|
"userName"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"userName": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"userGroupIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"languageIsoCode": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"documentStartNodeIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"hasDocumentRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaStartNodeIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"hasMediaRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"avatarUrls": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"languages": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"hasAccessToAllLanguages": {
|
|
"type": "boolean"
|
|
},
|
|
"hasAccessToSensitiveData": {
|
|
"type": "boolean"
|
|
},
|
|
"fallbackPermissions": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"permissions": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentPermissionPresentationModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DocumentPropertyValuePermissionPresentationModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UnknownTypePermissionPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"allowedSections": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"isAdmin": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DataTypeChangeModeModel": {
|
|
"enum": [
|
|
"True",
|
|
"False",
|
|
"FalseWithHelpText"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"DataTypeItemResponseModel": {
|
|
"required": [
|
|
"editorAlias",
|
|
"flags",
|
|
"id",
|
|
"isDeletable",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"editorUiAlias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"editorAlias": {
|
|
"type": "string"
|
|
},
|
|
"isDeletable": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DataTypePropertyPresentationModel": {
|
|
"required": [
|
|
"alias"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DataTypeResponseModel": {
|
|
"required": [
|
|
"canIgnoreStartNodes",
|
|
"editorAlias",
|
|
"editorUiAlias",
|
|
"id",
|
|
"isDeletable",
|
|
"name",
|
|
"values"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"editorAlias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"editorUiAlias": {
|
|
"type": "string"
|
|
},
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DataTypePropertyPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"isDeletable": {
|
|
"type": "boolean"
|
|
},
|
|
"canIgnoreStartNodes": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DataTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"hasChildren",
|
|
"id",
|
|
"isDeletable",
|
|
"isFolder",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"isFolder": {
|
|
"type": "boolean"
|
|
},
|
|
"editorUiAlias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"isDeletable": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DatabaseInstallRequestModel": {
|
|
"required": [
|
|
"id",
|
|
"providerName",
|
|
"trustServerCertificate",
|
|
"useIntegratedAuthentication"
|
|
],
|
|
"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
|
|
},
|
|
"trustServerCertificate": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DatabaseSettingsPresentationModel": {
|
|
"required": [
|
|
"defaultDatabaseName",
|
|
"displayName",
|
|
"id",
|
|
"isConfigured",
|
|
"providerName",
|
|
"requiresConnectionTest",
|
|
"requiresCredentials",
|
|
"requiresServer",
|
|
"serverPlaceholder",
|
|
"sortOrder",
|
|
"supportsIntegratedAuthentication",
|
|
"supportsTrustServerCertificate"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"displayName": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"defaultDatabaseName": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"providerName": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"isConfigured": {
|
|
"type": "boolean"
|
|
},
|
|
"requiresServer": {
|
|
"type": "boolean"
|
|
},
|
|
"serverPlaceholder": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"requiresCredentials": {
|
|
"type": "boolean"
|
|
},
|
|
"supportsIntegratedAuthentication": {
|
|
"type": "boolean"
|
|
},
|
|
"supportsTrustServerCertificate": {
|
|
"type": "boolean"
|
|
},
|
|
"requiresConnectionTest": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DatatypeConfigurationResponseModel": {
|
|
"required": [
|
|
"canBeChanged",
|
|
"documentListViewId",
|
|
"mediaListViewId"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"canBeChanged": {
|
|
"$ref": "#/components/schemas/DataTypeChangeModeModel"
|
|
},
|
|
"documentListViewId": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"mediaListViewId": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DefaultReferenceResponseModel": {
|
|
"required": [
|
|
"$type",
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"$type": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"discriminator": {
|
|
"propertyName": "$type",
|
|
"mapping": {
|
|
"DefaultReferenceResponseModel": "#/components/schemas/DefaultReferenceResponseModel"
|
|
}
|
|
}
|
|
},
|
|
"DeleteUserGroupsRequestModel": {
|
|
"required": [
|
|
"userGroupIds"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"userGroupIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DeleteUsersRequestModel": {
|
|
"required": [
|
|
"userIds"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"userIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DictionaryItemItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DictionaryItemResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"translations"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"translations": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DictionaryItemTranslationModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DictionaryItemTranslationModel": {
|
|
"required": [
|
|
"isoCode",
|
|
"translation"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"isoCode": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"translation": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DictionaryOverviewResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"translatedIsoCodes"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"translatedIsoCodes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DirectionModel": {
|
|
"enum": [
|
|
"Ascending",
|
|
"Descending"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"DisableUserRequestModel": {
|
|
"required": [
|
|
"userIds"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"userIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentBlueprintItemResponseModel": {
|
|
"required": [
|
|
"documentType",
|
|
"flags",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentBlueprintResponseModel": {
|
|
"required": [
|
|
"documentType",
|
|
"flags",
|
|
"id",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentValueResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentBlueprintTreeItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"hasChildren",
|
|
"id",
|
|
"isFolder",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"isFolder": {
|
|
"type": "boolean"
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentCollectionResponseModel": {
|
|
"required": [
|
|
"ancestors",
|
|
"documentType",
|
|
"flags",
|
|
"id",
|
|
"isProtected",
|
|
"isTrashed",
|
|
"sortOrder",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentValueResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"creator": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeCollectionReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"isTrashed": {
|
|
"type": "boolean"
|
|
},
|
|
"isProtected": {
|
|
"type": "boolean"
|
|
},
|
|
"ancestors": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"updater": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentConfigurationResponseModel": {
|
|
"required": [
|
|
"allowEditInvariantFromNonDefault",
|
|
"allowNonExistingSegmentsCreation",
|
|
"disableDeleteWhenReferenced",
|
|
"disableUnpublishWhenReferenced"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"disableDeleteWhenReferenced": {
|
|
"type": "boolean"
|
|
},
|
|
"disableUnpublishWhenReferenced": {
|
|
"type": "boolean"
|
|
},
|
|
"allowEditInvariantFromNonDefault": {
|
|
"type": "boolean"
|
|
},
|
|
"allowNonExistingSegmentsCreation": {
|
|
"type": "boolean",
|
|
"deprecated": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentItemResponseModel": {
|
|
"required": [
|
|
"documentType",
|
|
"flags",
|
|
"hasChildren",
|
|
"id",
|
|
"isProtected",
|
|
"isTrashed",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"isTrashed": {
|
|
"type": "boolean"
|
|
},
|
|
"isProtected": {
|
|
"type": "boolean"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentNotificationResponseModel": {
|
|
"required": [
|
|
"actionId",
|
|
"alias",
|
|
"subscribed"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"actionId": {
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"type": "string"
|
|
},
|
|
"subscribed": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentPermissionPresentationModel": {
|
|
"required": [
|
|
"$type",
|
|
"document",
|
|
"verbs"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"$type": {
|
|
"type": "string"
|
|
},
|
|
"document": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"verbs": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"discriminator": {
|
|
"propertyName": "$type",
|
|
"mapping": {
|
|
"DocumentPermissionPresentationModel": "#/components/schemas/DocumentPermissionPresentationModel"
|
|
}
|
|
}
|
|
},
|
|
"DocumentPropertyValuePermissionPresentationModel": {
|
|
"required": [
|
|
"$type",
|
|
"documentType",
|
|
"propertyType",
|
|
"verbs"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"$type": {
|
|
"type": "string"
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"propertyType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"verbs": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"discriminator": {
|
|
"propertyName": "$type",
|
|
"mapping": {
|
|
"DocumentPropertyValuePermissionPresentationModel": "#/components/schemas/DocumentPropertyValuePermissionPresentationModel"
|
|
}
|
|
}
|
|
},
|
|
"DocumentRecycleBinItemResponseModel": {
|
|
"required": [
|
|
"createDate",
|
|
"documentType",
|
|
"hasChildren",
|
|
"id",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"createDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ItemReferenceByIdResponseModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentReferenceResponseModel": {
|
|
"required": [
|
|
"$type",
|
|
"documentType",
|
|
"id",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"$type": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"published": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TrackedReferenceDocumentTypeModel"
|
|
}
|
|
]
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"discriminator": {
|
|
"propertyName": "$type",
|
|
"mapping": {
|
|
"DocumentReferenceResponseModel": "#/components/schemas/DocumentReferenceResponseModel"
|
|
}
|
|
}
|
|
},
|
|
"DocumentResponseModel": {
|
|
"required": [
|
|
"documentType",
|
|
"flags",
|
|
"id",
|
|
"isTrashed",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentValueResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"template": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isTrashed": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTreeItemResponseModel": {
|
|
"required": [
|
|
"ancestors",
|
|
"createDate",
|
|
"documentType",
|
|
"flags",
|
|
"hasChildren",
|
|
"id",
|
|
"isProtected",
|
|
"isTrashed",
|
|
"noAccess",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"noAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"isTrashed": {
|
|
"type": "boolean"
|
|
},
|
|
"createDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"isProtected": {
|
|
"type": "boolean"
|
|
},
|
|
"ancestors": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeBlueprintItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeCleanupModel": {
|
|
"required": [
|
|
"preventCleanup"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"preventCleanup": {
|
|
"type": "boolean"
|
|
},
|
|
"keepAllVersionsNewerThanDays": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"keepLatestVersionPerDayForDays": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeCollectionReferenceResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"icon",
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"alias": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeCompositionModel": {
|
|
"required": [
|
|
"compositionType",
|
|
"documentType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"compositionType": {
|
|
"$ref": "#/components/schemas/CompositionTypeModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeCompositionRequestModel": {
|
|
"required": [
|
|
"currentCompositeIds",
|
|
"currentPropertyAliases",
|
|
"isElement"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"currentPropertyAliases": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"currentCompositeIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeCompositionResponseModel": {
|
|
"required": [
|
|
"icon",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeConfigurationResponseModel": {
|
|
"required": [
|
|
"dataTypesCanBeChanged",
|
|
"disableTemplates",
|
|
"reservedFieldNames",
|
|
"useSegments"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"dataTypesCanBeChanged": {
|
|
"$ref": "#/components/schemas/DataTypeChangeModeModel"
|
|
},
|
|
"disableTemplates": {
|
|
"type": "boolean"
|
|
},
|
|
"useSegments": {
|
|
"type": "boolean"
|
|
},
|
|
"reservedFieldNames": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"isElement",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypePropertyTypeContainerResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"sortOrder",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypePropertyTypeReferenceResponseModel": {
|
|
"required": [
|
|
"$type",
|
|
"documentType",
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"$type": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TrackedReferenceDocumentTypeModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"discriminator": {
|
|
"propertyName": "$type",
|
|
"mapping": {
|
|
"DocumentTypePropertyTypeReferenceResponseModel": "#/components/schemas/DocumentTypePropertyTypeReferenceResponseModel"
|
|
}
|
|
}
|
|
},
|
|
"DocumentTypePropertyTypeResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"appearance",
|
|
"dataType",
|
|
"id",
|
|
"name",
|
|
"sortOrder",
|
|
"validation",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"container": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"dataType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"validation": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeValidationModel"
|
|
}
|
|
]
|
|
},
|
|
"appearance": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeReferenceResponseModel": {
|
|
"required": [
|
|
"icon",
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"allowedAsRoot",
|
|
"allowedDocumentTypes",
|
|
"allowedTemplates",
|
|
"cleanup",
|
|
"compositions",
|
|
"containers",
|
|
"icon",
|
|
"id",
|
|
"isElement",
|
|
"name",
|
|
"properties",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"allowedAsRoot": {
|
|
"type": "boolean"
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
},
|
|
"properties": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypePropertyTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"containers": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypePropertyTypeContainerResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"allowedTemplates": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultTemplate": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"cleanup": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeCleanupModel"
|
|
}
|
|
]
|
|
},
|
|
"allowedDocumentTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeSortModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"compositions": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeCompositionModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeSortModel": {
|
|
"required": [
|
|
"documentType",
|
|
"sortOrder"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"hasChildren",
|
|
"icon",
|
|
"id",
|
|
"isElement",
|
|
"isFolder",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"isFolder": {
|
|
"type": "boolean"
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentUrlInfoModel": {
|
|
"required": [
|
|
"culture",
|
|
"message",
|
|
"provider",
|
|
"url"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"provider": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentUrlInfoResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"urlInfos"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"urlInfos": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentUrlInfoModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentValueModel": {
|
|
"required": [
|
|
"alias"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentValueResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"editorAlias"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true
|
|
},
|
|
"editorAlias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentVariantItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"name",
|
|
"state"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"readOnly": true
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"state": {
|
|
"$ref": "#/components/schemas/DocumentVariantStateModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentVariantRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentVariantResponseModel": {
|
|
"required": [
|
|
"createDate",
|
|
"flags",
|
|
"id",
|
|
"name",
|
|
"state",
|
|
"updateDate"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"createDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"updateDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"state": {
|
|
"$ref": "#/components/schemas/DocumentVariantStateModel"
|
|
},
|
|
"publishDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"scheduledPublishDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"scheduledUnpublishDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"readOnly": true
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentVariantStateModel": {
|
|
"enum": [
|
|
"NotCreated",
|
|
"Draft",
|
|
"Published",
|
|
"PublishedPendingChanges",
|
|
"Trashed"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"DocumentVersionItemResponseModel": {
|
|
"required": [
|
|
"document",
|
|
"documentType",
|
|
"id",
|
|
"isCurrentDraftVersion",
|
|
"isCurrentPublishedVersion",
|
|
"preventCleanup",
|
|
"user",
|
|
"versionDate"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"document": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"user": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"versionDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"isCurrentPublishedVersion": {
|
|
"type": "boolean"
|
|
},
|
|
"isCurrentDraftVersion": {
|
|
"type": "boolean"
|
|
},
|
|
"preventCleanup": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DocumentVersionResponseModel": {
|
|
"required": [
|
|
"documentType",
|
|
"flags",
|
|
"id",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentValueResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"document": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DomainPresentationModel": {
|
|
"required": [
|
|
"domainName",
|
|
"isoCode"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"domainName": {
|
|
"type": "string"
|
|
},
|
|
"isoCode": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DomainsResponseModel": {
|
|
"required": [
|
|
"domains"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"defaultIsoCode": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"domains": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DomainPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DynamicRootContextRequestModel": {
|
|
"required": [
|
|
"parent"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DynamicRootQueryOriginRequestModel": {
|
|
"required": [
|
|
"alias"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DynamicRootQueryRequestModel": {
|
|
"required": [
|
|
"origin",
|
|
"steps"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"origin": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DynamicRootQueryOriginRequestModel"
|
|
}
|
|
]
|
|
},
|
|
"steps": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DynamicRootQueryStepRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DynamicRootQueryStepRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"documentTypeIds"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"type": "string"
|
|
},
|
|
"documentTypeIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DynamicRootRequestModel": {
|
|
"required": [
|
|
"context",
|
|
"query"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"context": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DynamicRootContextRequestModel"
|
|
}
|
|
]
|
|
},
|
|
"query": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DynamicRootQueryRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DynamicRootResponseModel": {
|
|
"required": [
|
|
"roots"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"roots": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"EnableTwoFactorRequestModel": {
|
|
"required": [
|
|
"code",
|
|
"secret"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"EnableUserRequestModel": {
|
|
"required": [
|
|
"userIds"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"userIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"EntityImportAnalysisResponseModel": {
|
|
"required": [
|
|
"entityType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"entityType": {
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"EventMessageTypeModel": {
|
|
"enum": [
|
|
"Default",
|
|
"Info",
|
|
"Error",
|
|
"Success",
|
|
"Warning"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"FieldPresentationModel": {
|
|
"required": [
|
|
"name",
|
|
"values"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"FileSystemFolderModel": {
|
|
"required": [
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"FileSystemTreeItemPresentationModel": {
|
|
"required": [
|
|
"hasChildren",
|
|
"isFolder",
|
|
"name",
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isFolder": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"FlagModel": {
|
|
"required": [
|
|
"alias"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"FolderResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"HealthCheckActionRequestModel": {
|
|
"required": [
|
|
"healthCheck",
|
|
"valueRequired"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"healthCheck": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"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
|
|
},
|
|
"actionParameters": {
|
|
"type": "object",
|
|
"additionalProperties": { },
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"HealthCheckGroupPresentationModel": {
|
|
"required": [
|
|
"checks",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"checks": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthCheckModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"HealthCheckGroupResponseModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"HealthCheckGroupWithResultResponseModel": {
|
|
"required": [
|
|
"checks"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"checks": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthCheckWithResultPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"HealthCheckModel": {
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"HealthCheckResultResponseModel": {
|
|
"required": [
|
|
"message",
|
|
"resultType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"resultType": {
|
|
"$ref": "#/components/schemas/StatusResultTypeModel"
|
|
},
|
|
"actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthCheckActionRequestModel"
|
|
}
|
|
]
|
|
},
|
|
"nullable": true
|
|
},
|
|
"readMoreLink": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"HealthCheckWithResultPresentationModel": {
|
|
"required": [
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"results": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthCheckResultResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"HealthStatusModel": {
|
|
"enum": [
|
|
"Healthy",
|
|
"Unhealthy",
|
|
"Rebuilding",
|
|
"Corrupt"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"HealthStatusResponseModel": {
|
|
"required": [
|
|
"status"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"$ref": "#/components/schemas/HealthStatusModel"
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"HelpPageResponseModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ImageCropModeModel": {
|
|
"enum": [
|
|
"Crop",
|
|
"Max",
|
|
"Stretch",
|
|
"Pad",
|
|
"BoxPad",
|
|
"Min"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"ImportDictionaryRequestModel": {
|
|
"required": [
|
|
"temporaryFile"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"temporaryFile": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ImportDocumentTypeRequestModel": {
|
|
"required": [
|
|
"file"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"file": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ImportMediaTypeRequestModel": {
|
|
"required": [
|
|
"file"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"file": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ImportMemberTypeRequestModel": {
|
|
"required": [
|
|
"file"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"file": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"IndexResponseModel": {
|
|
"required": [
|
|
"canRebuild",
|
|
"documentCount",
|
|
"fieldCount",
|
|
"healthStatus",
|
|
"name",
|
|
"searcherName"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"healthStatus": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthStatusResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"canRebuild": {
|
|
"type": "boolean"
|
|
},
|
|
"searcherName": {
|
|
"type": "string"
|
|
},
|
|
"documentCount": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"fieldCount": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"providerProperties": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"nullable": true
|
|
},
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"InstallRequestModel": {
|
|
"required": [
|
|
"database",
|
|
"telemetryLevel",
|
|
"user"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"user": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserInstallRequestModel"
|
|
}
|
|
]
|
|
},
|
|
"database": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DatabaseInstallRequestModel"
|
|
}
|
|
]
|
|
},
|
|
"telemetryLevel": {
|
|
"$ref": "#/components/schemas/TelemetryLevelModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"InstallSettingsResponseModel": {
|
|
"required": [
|
|
"databases",
|
|
"user"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"user": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserSettingsPresentationModel"
|
|
}
|
|
]
|
|
},
|
|
"databases": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DatabaseSettingsPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"InviteUserRequestModel": {
|
|
"required": [
|
|
"email",
|
|
"name",
|
|
"userGroupIds",
|
|
"userName"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"userName": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"userGroupIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ItemReferenceByIdResponseModel": {
|
|
"required": [
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ItemSortingRequestModel": {
|
|
"required": [
|
|
"id",
|
|
"sortOrder"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"LanguageItemResponseModel": {
|
|
"required": [
|
|
"isoCode",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"isoCode": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"LanguageResponseModel": {
|
|
"required": [
|
|
"isDefault",
|
|
"isMandatory",
|
|
"isoCode",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"isDefault": {
|
|
"type": "boolean"
|
|
},
|
|
"isMandatory": {
|
|
"type": "boolean"
|
|
},
|
|
"fallbackIsoCode": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"isoCode": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"LogLevelCountsReponseModel": {
|
|
"required": [
|
|
"debug",
|
|
"error",
|
|
"fatal",
|
|
"information",
|
|
"warning"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"information": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"debug": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"warning": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"error": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"fatal": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"LogLevelModel": {
|
|
"enum": [
|
|
"Verbose",
|
|
"Debug",
|
|
"Information",
|
|
"Warning",
|
|
"Error",
|
|
"Fatal"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"LogMessagePropertyPresentationModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"LogMessageResponseModel": {
|
|
"required": [
|
|
"level",
|
|
"properties",
|
|
"timestamp"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"timestamp": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"level": {
|
|
"$ref": "#/components/schemas/LogLevelModel"
|
|
},
|
|
"messageTemplate": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"renderedMessage": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"properties": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LogMessagePropertyPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"exception": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"LogTemplateResponseModel": {
|
|
"required": [
|
|
"count"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"messageTemplate": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"count": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"LoggerResponseModel": {
|
|
"required": [
|
|
"level",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"level": {
|
|
"$ref": "#/components/schemas/LogLevelModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ManifestResponseModel": {
|
|
"required": [
|
|
"extensions",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"version": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"extensions": {
|
|
"type": "array",
|
|
"items": { }
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaCollectionResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"mediaType",
|
|
"sortOrder",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaValueResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaVariantResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"creator": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"mediaType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeCollectionReferenceResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaConfigurationResponseModel": {
|
|
"required": [
|
|
"disableDeleteWhenReferenced",
|
|
"disableUnpublishWhenReferenced"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"disableDeleteWhenReferenced": {
|
|
"type": "boolean"
|
|
},
|
|
"disableUnpublishWhenReferenced": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"hasChildren",
|
|
"id",
|
|
"isTrashed",
|
|
"mediaType",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"isTrashed": {
|
|
"type": "boolean"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VariantItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaRecycleBinItemResponseModel": {
|
|
"required": [
|
|
"createDate",
|
|
"hasChildren",
|
|
"id",
|
|
"mediaType",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"createDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ItemReferenceByIdResponseModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"mediaType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VariantItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaReferenceResponseModel": {
|
|
"required": [
|
|
"$type",
|
|
"id",
|
|
"mediaType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"$type": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"mediaType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TrackedReferenceMediaTypeModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"discriminator": {
|
|
"propertyName": "$type",
|
|
"mapping": {
|
|
"MediaReferenceResponseModel": "#/components/schemas/MediaReferenceResponseModel"
|
|
}
|
|
}
|
|
},
|
|
"MediaResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"isTrashed",
|
|
"mediaType",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaValueResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaVariantResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"isTrashed": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTreeItemResponseModel": {
|
|
"required": [
|
|
"createDate",
|
|
"flags",
|
|
"hasChildren",
|
|
"id",
|
|
"isTrashed",
|
|
"mediaType",
|
|
"noAccess",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"noAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"isTrashed": {
|
|
"type": "boolean"
|
|
},
|
|
"createDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"mediaType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VariantItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypeCollectionReferenceResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"icon",
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"alias": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypeCompositionModel": {
|
|
"required": [
|
|
"compositionType",
|
|
"mediaType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"mediaType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"compositionType": {
|
|
"$ref": "#/components/schemas/CompositionTypeModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypeCompositionRequestModel": {
|
|
"required": [
|
|
"currentCompositeIds",
|
|
"currentPropertyAliases"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"currentPropertyAliases": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"currentCompositeIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypeCompositionResponseModel": {
|
|
"required": [
|
|
"icon",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypeConfigurationResponseModel": {
|
|
"required": [
|
|
"reservedFieldNames"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"reservedFieldNames": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypeItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypePropertyTypeContainerResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"sortOrder",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypePropertyTypeReferenceResponseModel": {
|
|
"required": [
|
|
"$type",
|
|
"id",
|
|
"mediaType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"$type": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"mediaType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TrackedReferenceMediaTypeModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"discriminator": {
|
|
"propertyName": "$type",
|
|
"mapping": {
|
|
"MediaTypePropertyTypeReferenceResponseModel": "#/components/schemas/MediaTypePropertyTypeReferenceResponseModel"
|
|
}
|
|
}
|
|
},
|
|
"MediaTypePropertyTypeResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"appearance",
|
|
"dataType",
|
|
"id",
|
|
"name",
|
|
"sortOrder",
|
|
"validation",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"container": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"dataType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"validation": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeValidationModel"
|
|
}
|
|
]
|
|
},
|
|
"appearance": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypeReferenceResponseModel": {
|
|
"required": [
|
|
"icon",
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypeResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"aliasCanBeChanged",
|
|
"allowedAsRoot",
|
|
"allowedMediaTypes",
|
|
"compositions",
|
|
"containers",
|
|
"icon",
|
|
"id",
|
|
"isDeletable",
|
|
"isElement",
|
|
"name",
|
|
"properties",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"allowedAsRoot": {
|
|
"type": "boolean"
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
},
|
|
"properties": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypePropertyTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"containers": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypePropertyTypeContainerResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"allowedMediaTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeSortModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"compositions": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeCompositionModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"isDeletable": {
|
|
"type": "boolean"
|
|
},
|
|
"aliasCanBeChanged": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypeSortModel": {
|
|
"required": [
|
|
"mediaType",
|
|
"sortOrder"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"mediaType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"hasChildren",
|
|
"icon",
|
|
"id",
|
|
"isDeletable",
|
|
"isFolder",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"isFolder": {
|
|
"type": "boolean"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"isDeletable": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaUrlInfoModel": {
|
|
"required": [
|
|
"culture",
|
|
"url"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaUrlInfoResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"urlInfos"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"urlInfos": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaUrlInfoModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaValueModel": {
|
|
"required": [
|
|
"alias"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaValueResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"editorAlias"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true
|
|
},
|
|
"editorAlias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaVariantRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MediaVariantResponseModel": {
|
|
"required": [
|
|
"createDate",
|
|
"name",
|
|
"updateDate"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"createDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"updateDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberConfigurationResponseModel": {
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"MemberGroupItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberGroupResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"kind",
|
|
"memberType",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"memberType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/VariantItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"kind": {
|
|
"$ref": "#/components/schemas/MemberKindModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberKindModel": {
|
|
"enum": [
|
|
"Default",
|
|
"Api"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"MemberReferenceResponseModel": {
|
|
"required": [
|
|
"$type",
|
|
"id",
|
|
"memberType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"$type": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"memberType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TrackedReferenceMemberTypeModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"discriminator": {
|
|
"propertyName": "$type",
|
|
"mapping": {
|
|
"MemberReferenceResponseModel": "#/components/schemas/MemberReferenceResponseModel"
|
|
}
|
|
}
|
|
},
|
|
"MemberResponseModel": {
|
|
"required": [
|
|
"email",
|
|
"failedPasswordAttempts",
|
|
"flags",
|
|
"groups",
|
|
"id",
|
|
"isApproved",
|
|
"isLockedOut",
|
|
"isTwoFactorEnabled",
|
|
"kind",
|
|
"memberType",
|
|
"username",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberValueResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberVariantResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"memberType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"isApproved": {
|
|
"type": "boolean"
|
|
},
|
|
"isLockedOut": {
|
|
"type": "boolean"
|
|
},
|
|
"isTwoFactorEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"failedPasswordAttempts": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"lastLoginDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"lastLockoutDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"lastPasswordChangeDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"kind": {
|
|
"$ref": "#/components/schemas/MemberKindModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberTypeCompositionModel": {
|
|
"required": [
|
|
"compositionType",
|
|
"memberType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"memberType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"compositionType": {
|
|
"$ref": "#/components/schemas/CompositionTypeModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberTypeCompositionRequestModel": {
|
|
"required": [
|
|
"currentCompositeIds",
|
|
"currentPropertyAliases"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"nullable": true
|
|
},
|
|
"currentPropertyAliases": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"currentCompositeIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberTypeCompositionResponseModel": {
|
|
"required": [
|
|
"icon",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberTypeConfigurationResponseModel": {
|
|
"required": [
|
|
"reservedFieldNames"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"reservedFieldNames": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberTypeItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberTypePropertyTypeContainerResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"sortOrder",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberTypePropertyTypeReferenceResponseModel": {
|
|
"required": [
|
|
"$type",
|
|
"id",
|
|
"memberType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"$type": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"memberType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TrackedReferenceMemberTypeModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"discriminator": {
|
|
"propertyName": "$type",
|
|
"mapping": {
|
|
"MemberTypePropertyTypeReferenceResponseModel": "#/components/schemas/MemberTypePropertyTypeReferenceResponseModel"
|
|
}
|
|
}
|
|
},
|
|
"MemberTypePropertyTypeResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"appearance",
|
|
"dataType",
|
|
"id",
|
|
"isSensitive",
|
|
"name",
|
|
"sortOrder",
|
|
"validation",
|
|
"variesByCulture",
|
|
"variesBySegment",
|
|
"visibility"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"container": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"dataType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"validation": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeValidationModel"
|
|
}
|
|
]
|
|
},
|
|
"appearance": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
|
|
}
|
|
]
|
|
},
|
|
"isSensitive": {
|
|
"type": "boolean"
|
|
},
|
|
"visibility": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypePropertyTypeVisibilityModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberTypePropertyTypeVisibilityModel": {
|
|
"required": [
|
|
"memberCanEdit",
|
|
"memberCanView"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"memberCanView": {
|
|
"type": "boolean"
|
|
},
|
|
"memberCanEdit": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberTypeReferenceResponseModel": {
|
|
"required": [
|
|
"icon",
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberTypeResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"allowedAsRoot",
|
|
"compositions",
|
|
"containers",
|
|
"icon",
|
|
"id",
|
|
"isElement",
|
|
"name",
|
|
"properties",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"allowedAsRoot": {
|
|
"type": "boolean"
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
},
|
|
"properties": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypePropertyTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"containers": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypePropertyTypeContainerResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"compositions": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeCompositionModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"hasChildren",
|
|
"icon",
|
|
"id",
|
|
"isFolder",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"isFolder": {
|
|
"type": "boolean"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberValueModel": {
|
|
"required": [
|
|
"alias"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberValueResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"editorAlias"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true
|
|
},
|
|
"editorAlias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberVariantRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MemberVariantResponseModel": {
|
|
"required": [
|
|
"createDate",
|
|
"name",
|
|
"updateDate"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"segment": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"createDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"updateDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ModelsBuilderResponseModel": {
|
|
"required": [
|
|
"canGenerate",
|
|
"mode",
|
|
"outOfDateModels",
|
|
"trackingOutOfDateModels"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"mode": {
|
|
"type": "string"
|
|
},
|
|
"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
|
|
},
|
|
"MoveDataTypeRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MoveDictionaryRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MoveDocumentBlueprintRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MoveDocumentRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MoveDocumentTypeRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MoveMediaRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MoveMediaTypeRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MoveMemberTypeRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"target": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"NamedEntityTreeItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"hasChildren",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"hasChildren": {
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"NewsDashboardItemResponseModel": {
|
|
"required": [
|
|
"header",
|
|
"priority"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"priority": {
|
|
"type": "string"
|
|
},
|
|
"header": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"buttonText": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"imageUrl": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"imageAltText": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"NewsDashboardResponseModel": {
|
|
"required": [
|
|
"items"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/NewsDashboardItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"NoopSetupTwoFactorModel": {
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"NotificationHeaderModel": {
|
|
"required": [
|
|
"category",
|
|
"message",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"category": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"$ref": "#/components/schemas/EventMessageTypeModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"OEmbedResponseModel": {
|
|
"required": [
|
|
"markup"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"markup": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ObjectTypeResponseModel": {
|
|
"required": [
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"OperatorModel": {
|
|
"enum": [
|
|
"Equals",
|
|
"NotEquals",
|
|
"Contains",
|
|
"NotContains",
|
|
"LessThan",
|
|
"LessThanEqualTo",
|
|
"GreaterThan",
|
|
"GreaterThanEqualTo"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"OutOfDateStatusResponseModel": {
|
|
"required": [
|
|
"status"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"$ref": "#/components/schemas/OutOfDateTypeModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"OutOfDateTypeModel": {
|
|
"enum": [
|
|
"OutOfDate",
|
|
"Current",
|
|
"Unknown"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"PackageConfigurationResponseModel": {
|
|
"required": [
|
|
"marketplaceUrl"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"marketplaceUrl": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PackageDefinitionResponseModel": {
|
|
"required": [
|
|
"contentLoadChildNodes",
|
|
"dataTypes",
|
|
"dictionaryItems",
|
|
"documentTypes",
|
|
"id",
|
|
"languages",
|
|
"mediaIds",
|
|
"mediaLoadChildNodes",
|
|
"mediaTypes",
|
|
"name",
|
|
"packagePath",
|
|
"partialViews",
|
|
"scripts",
|
|
"stylesheets",
|
|
"templates"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"contentNodeId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"contentLoadChildNodes": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"mediaLoadChildNodes": {
|
|
"type": "boolean"
|
|
},
|
|
"documentTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"mediaTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"dataTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"templates": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"partialViews": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"stylesheets": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"scripts": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"languages": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"dictionaryItems": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"packagePath": {
|
|
"type": "string",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PackageMigrationStatusResponseModel": {
|
|
"required": [
|
|
"hasPendingMigrations",
|
|
"packageName"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"packageName": {
|
|
"type": "string"
|
|
},
|
|
"hasPendingMigrations": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedAllowedDocumentTypeModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/AllowedDocumentTypeModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedAllowedMediaTypeModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/AllowedMediaTypeModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedAuditLogResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/AuditLogResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedCultureReponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CultureReponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedDataTypeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DataTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedDataTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DataTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedDictionaryOverviewResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DictionaryOverviewResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedDocumentBlueprintTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentBlueprintTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedDocumentCollectionResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentCollectionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedDocumentRecycleBinItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentRecycleBinItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedDocumentTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedDocumentTypeBlueprintItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeBlueprintItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedDocumentTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedDocumentVersionItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVersionItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedFileSystemTreeItemPresentationModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedHealthCheckGroupResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HealthCheckGroupResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedHelpPageResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/HelpPageResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedIReferenceResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DefaultReferenceResponseModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DocumentReferenceResponseModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypePropertyTypeReferenceResponseModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/MediaReferenceResponseModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypePropertyTypeReferenceResponseModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/MemberReferenceResponseModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypePropertyTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedIndexResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/IndexResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedLanguageResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LanguageResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedLogMessageResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LogMessageResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedLogTemplateResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LogTemplateResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedLoggerResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LoggerResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedMediaCollectionResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaCollectionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedMediaRecycleBinItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaRecycleBinItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedMediaTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedMediaTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedMemberGroupResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberGroupResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedMemberResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedMemberTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedModelDataTypeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DataTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedModelDocumentItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedModelDocumentTypeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedModelMediaItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedModelMediaTypeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedModelMemberItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedModelMemberTypeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedModelTemplateItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedNamedEntityTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/NamedEntityTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedObjectTypeResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ObjectTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedPackageDefinitionResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PackageDefinitionResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedPackageMigrationStatusResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PackageMigrationStatusResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedPartialViewSnippetItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PartialViewSnippetItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedProblemDetailsModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedRedirectUrlResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RedirectUrlResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedReferenceByIdModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedRelationResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RelationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedRelationTypeResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RelationTypeResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedSavedLogSearchResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SavedLogSearchResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedSearchResultResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SearchResultResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedSearcherResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SearcherResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedSegmentResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/SegmentResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedTagResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TagResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedTelemetryResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TelemetryResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedUserDataResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserDataResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedUserGroupResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserGroupResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedUserResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedWebhookEventModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WebhookEventModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedWebhookLogResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WebhookLogResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PagedWebhookResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"total"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WebhookResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PartialViewFolderResponseModel": {
|
|
"required": [
|
|
"name",
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PartialViewItemResponseModel": {
|
|
"required": [
|
|
"isFolder",
|
|
"name",
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isFolder": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PartialViewResponseModel": {
|
|
"required": [
|
|
"content",
|
|
"name",
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PartialViewSnippetItemResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PartialViewSnippetResponseModel": {
|
|
"required": [
|
|
"content",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PasswordConfigurationResponseModel": {
|
|
"required": [
|
|
"minimumPasswordLength",
|
|
"requireDigit",
|
|
"requireLowercase",
|
|
"requireNonLetterOrDigit",
|
|
"requireUppercase"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"minimumPasswordLength": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"requireNonLetterOrDigit": {
|
|
"type": "boolean"
|
|
},
|
|
"requireDigit": {
|
|
"type": "boolean"
|
|
},
|
|
"requireLowercase": {
|
|
"type": "boolean"
|
|
},
|
|
"requireUppercase": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ProblemDetails": {
|
|
"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": { }
|
|
},
|
|
"ProblemDetailsBuilderModel": {
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"ProfilingStatusRequestModel": {
|
|
"required": [
|
|
"enabled"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ProfilingStatusResponseModel": {
|
|
"required": [
|
|
"enabled"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PropertyTypeAppearanceModel": {
|
|
"required": [
|
|
"labelOnTop"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"labelOnTop": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PropertyTypeValidationModel": {
|
|
"required": [
|
|
"mandatory"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"mandatory": {
|
|
"type": "boolean"
|
|
},
|
|
"mandatoryMessage": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"regEx": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"regExMessage": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PublicAccessRequestModel": {
|
|
"required": [
|
|
"errorDocument",
|
|
"loginDocument",
|
|
"memberGroupNames",
|
|
"memberUserNames"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"loginDocument": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"errorDocument": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"memberUserNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"memberGroupNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PublicAccessResponseModel": {
|
|
"required": [
|
|
"errorDocument",
|
|
"groups",
|
|
"loginDocument",
|
|
"members"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"loginDocument": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"errorDocument": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"members": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberGroupItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PublishDocumentRequestModel": {
|
|
"required": [
|
|
"publishSchedules"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"publishSchedules": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CultureAndScheduleRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PublishDocumentWithDescendantsRequestModel": {
|
|
"required": [
|
|
"cultures",
|
|
"includeUnpublishedDescendants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"includeUnpublishedDescendants": {
|
|
"type": "boolean"
|
|
},
|
|
"cultures": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PublishWithDescendantsResultModel": {
|
|
"required": [
|
|
"isComplete",
|
|
"taskId"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"taskId": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"isComplete": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PublishedDocumentResponseModel": {
|
|
"required": [
|
|
"documentType",
|
|
"flags",
|
|
"id",
|
|
"isTrashed",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentValueResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"documentType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeReferenceResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"template": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isTrashed": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RebuildStatusModel": {
|
|
"required": [
|
|
"isRebuilding"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"isRebuilding": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RedirectStatusModel": {
|
|
"enum": [
|
|
"Enabled",
|
|
"Disabled"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"RedirectUrlResponseModel": {
|
|
"required": [
|
|
"created",
|
|
"destinationUrl",
|
|
"document",
|
|
"id",
|
|
"originalUrl"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"originalUrl": {
|
|
"type": "string"
|
|
},
|
|
"destinationUrl": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"document": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RedirectUrlStatusResponseModel": {
|
|
"required": [
|
|
"status",
|
|
"userIsAdmin"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"$ref": "#/components/schemas/RedirectStatusModel"
|
|
},
|
|
"userIsAdmin": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ReferenceByIdModel": {
|
|
"required": [
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RelationReferenceModel": {
|
|
"required": [
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RelationResponseModel": {
|
|
"required": [
|
|
"child",
|
|
"createDate",
|
|
"id",
|
|
"parent",
|
|
"relationType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"relationType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RelationReferenceModel"
|
|
}
|
|
],
|
|
"readOnly": true
|
|
},
|
|
"child": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/RelationReferenceModel"
|
|
}
|
|
],
|
|
"readOnly": true
|
|
},
|
|
"createDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"readOnly": true
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RelationTypeItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"isDeletable",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"isDeletable": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RelationTypeResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"isBidirectional",
|
|
"isDependency",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"isBidirectional": {
|
|
"type": "boolean"
|
|
},
|
|
"isDependency": {
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"alias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"parentObject": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ObjectTypeResponseModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"childObject": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ObjectTypeResponseModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RenamePartialViewRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RenameScriptRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RenameStylesheetRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ResendInviteUserRequestModel": {
|
|
"required": [
|
|
"user"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"user": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ResetPasswordRequestModel": {
|
|
"required": [
|
|
"email"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"email": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ResetPasswordTokenRequestModel": {
|
|
"required": [
|
|
"password",
|
|
"resetCode",
|
|
"user"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"user": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"resetCode": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ResetPasswordUserResponseModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resetPassword": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RuntimeLevelModel": {
|
|
"enum": [
|
|
"Unknown",
|
|
"Boot",
|
|
"Install",
|
|
"Upgrade",
|
|
"Run",
|
|
"BootFailed"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"RuntimeModeModel": {
|
|
"enum": [
|
|
"BackofficeDevelopment",
|
|
"Development",
|
|
"Production"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"SavedLogSearchRequestModel": {
|
|
"required": [
|
|
"name",
|
|
"query"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SavedLogSearchResponseModel": {
|
|
"required": [
|
|
"name",
|
|
"query"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ScheduleRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"publishTime": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"unpublishTime": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ScriptFolderResponseModel": {
|
|
"required": [
|
|
"name",
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ScriptItemResponseModel": {
|
|
"required": [
|
|
"isFolder",
|
|
"name",
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isFolder": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ScriptResponseModel": {
|
|
"required": [
|
|
"content",
|
|
"name",
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SearchResultResponseModel": {
|
|
"required": [
|
|
"fieldCount",
|
|
"fields",
|
|
"id",
|
|
"score"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"score": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"fieldCount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"readOnly": true
|
|
},
|
|
"fields": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FieldPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SearcherResponseModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SecurityConfigurationResponseModel": {
|
|
"required": [
|
|
"passwordConfiguration"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"passwordConfiguration": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PasswordConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SegmentResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"type": "string"
|
|
},
|
|
"cultures": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"nullable": true,
|
|
"deprecated": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ServerConfigurationItemResponseModel": {
|
|
"required": [
|
|
"data",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"data": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ServerConfigurationResponseModel": {
|
|
"required": [
|
|
"allowLocalLogin",
|
|
"allowPasswordReset",
|
|
"versionCheckPeriod"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"allowPasswordReset": {
|
|
"type": "boolean"
|
|
},
|
|
"versionCheckPeriod": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"allowLocalLogin": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ServerInformationResponseModel": {
|
|
"required": [
|
|
"assemblyVersion",
|
|
"baseUtcOffset",
|
|
"runtimeMode",
|
|
"version"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string"
|
|
},
|
|
"assemblyVersion": {
|
|
"type": "string"
|
|
},
|
|
"baseUtcOffset": {
|
|
"type": "string"
|
|
},
|
|
"runtimeMode": {
|
|
"$ref": "#/components/schemas/RuntimeModeModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ServerStatusResponseModel": {
|
|
"required": [
|
|
"serverStatus"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"serverStatus": {
|
|
"$ref": "#/components/schemas/RuntimeLevelModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ServerTroubleshootingResponseModel": {
|
|
"required": [
|
|
"items"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ServerConfigurationItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SetAvatarRequestModel": {
|
|
"required": [
|
|
"file"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"file": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SortingRequestModel": {
|
|
"required": [
|
|
"sorting"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"sorting": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ItemSortingRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"StaticFileItemResponseModel": {
|
|
"required": [
|
|
"isFolder",
|
|
"name",
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isFolder": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"StatusResultTypeModel": {
|
|
"enum": [
|
|
"Success",
|
|
"Warning",
|
|
"Error",
|
|
"Info"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"StylesheetFolderResponseModel": {
|
|
"required": [
|
|
"name",
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"StylesheetItemResponseModel": {
|
|
"required": [
|
|
"isFolder",
|
|
"name",
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isFolder": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"StylesheetResponseModel": {
|
|
"required": [
|
|
"content",
|
|
"name",
|
|
"path"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemFolderModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SubsetDataTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"totalAfter",
|
|
"totalBefore"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"totalBefore": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"totalAfter": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DataTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SubsetDocumentBlueprintTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"totalAfter",
|
|
"totalBefore"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"totalBefore": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"totalAfter": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentBlueprintTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SubsetDocumentRecycleBinItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"totalAfter",
|
|
"totalBefore"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"totalBefore": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"totalAfter": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentRecycleBinItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SubsetDocumentTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"totalAfter",
|
|
"totalBefore"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"totalBefore": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"totalAfter": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SubsetDocumentTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"totalAfter",
|
|
"totalBefore"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"totalBefore": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"totalAfter": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SubsetFileSystemTreeItemPresentationModel": {
|
|
"required": [
|
|
"items",
|
|
"totalAfter",
|
|
"totalBefore"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"totalBefore": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"totalAfter": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FileSystemTreeItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SubsetMediaRecycleBinItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"totalAfter",
|
|
"totalBefore"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"totalBefore": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"totalAfter": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaRecycleBinItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SubsetMediaTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"totalAfter",
|
|
"totalBefore"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"totalBefore": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"totalAfter": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SubsetMediaTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"totalAfter",
|
|
"totalBefore"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"totalBefore": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"totalAfter": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SubsetMemberTypeTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"totalAfter",
|
|
"totalBefore"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"totalBefore": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"totalAfter": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SubsetNamedEntityTreeItemResponseModel": {
|
|
"required": [
|
|
"items",
|
|
"totalAfter",
|
|
"totalBefore"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"totalBefore": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"totalAfter": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/NamedEntityTreeItemResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TagResponseModel": {
|
|
"required": [
|
|
"id",
|
|
"nodeCount"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"text": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"group": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"nodeCount": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TelemetryLevelModel": {
|
|
"enum": [
|
|
"Minimal",
|
|
"Basic",
|
|
"Detailed"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"TelemetryRequestModel": {
|
|
"required": [
|
|
"telemetryLevel"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"telemetryLevel": {
|
|
"$ref": "#/components/schemas/TelemetryLevelModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TelemetryResponseModel": {
|
|
"required": [
|
|
"telemetryLevel"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"telemetryLevel": {
|
|
"$ref": "#/components/schemas/TelemetryLevelModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemplateConfigurationResponseModel": {
|
|
"required": [
|
|
"disabled"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemplateItemResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"flags",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemplateQueryExecuteFilterPresentationModel": {
|
|
"required": [
|
|
"constraintValue",
|
|
"operator",
|
|
"propertyAlias"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"propertyAlias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"constraintValue": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"$ref": "#/components/schemas/OperatorModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemplateQueryExecuteModel": {
|
|
"required": [
|
|
"take"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"rootDocument": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"documentTypeAlias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"filters": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateQueryExecuteFilterPresentationModel"
|
|
}
|
|
]
|
|
},
|
|
"nullable": true
|
|
},
|
|
"sort": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateQueryExecuteSortModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"take": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemplateQueryExecuteSortModel": {
|
|
"required": [
|
|
"propertyAlias"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"propertyAlias": {
|
|
"type": "string"
|
|
},
|
|
"direction": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemplateQueryOperatorModel": {
|
|
"required": [
|
|
"applicableTypes",
|
|
"operator"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"operator": {
|
|
"$ref": "#/components/schemas/OperatorModel"
|
|
},
|
|
"applicableTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/TemplateQueryPropertyTypeModel"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemplateQueryPropertyPresentationModel": {
|
|
"required": [
|
|
"alias",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"$ref": "#/components/schemas/TemplateQueryPropertyTypeModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemplateQueryPropertyTypeModel": {
|
|
"enum": [
|
|
"String",
|
|
"DateTime",
|
|
"Integer"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"TemplateQueryResultItemPresentationModel": {
|
|
"required": [
|
|
"icon",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemplateQueryResultResponseModel": {
|
|
"required": [
|
|
"executionTime",
|
|
"queryExpression",
|
|
"resultCount",
|
|
"sampleResults"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"queryExpression": {
|
|
"type": "string"
|
|
},
|
|
"sampleResults": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateQueryResultItemPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"resultCount": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"executionTime": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemplateQuerySettingsResponseModel": {
|
|
"required": [
|
|
"documentTypeAliases",
|
|
"operators",
|
|
"properties"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"documentTypeAliases": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"properties": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateQueryPropertyPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"operators": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/TemplateQueryOperatorModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemplateResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"masterTemplate": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemporaryFileConfigurationResponseModel": {
|
|
"required": [
|
|
"allowedUploadedFileExtensions",
|
|
"disallowedUploadedFilesExtensions",
|
|
"imageFileTypes"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"imageFileTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"disallowedUploadedFilesExtensions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"allowedUploadedFileExtensions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"maxFileSize": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TemporaryFileResponseModel": {
|
|
"required": [
|
|
"fileName",
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"availableUntil": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"fileName": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TrackedReferenceDocumentTypeModel": {
|
|
"required": [
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TrackedReferenceMediaTypeModel": {
|
|
"required": [
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"TrackedReferenceMemberTypeModel": {
|
|
"required": [
|
|
"id"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UnknownTypePermissionPresentationModel": {
|
|
"required": [
|
|
"$type",
|
|
"context",
|
|
"verbs"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"$type": {
|
|
"type": "string"
|
|
},
|
|
"verbs": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"context": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"discriminator": {
|
|
"propertyName": "$type",
|
|
"mapping": {
|
|
"UnknownTypePermissionPresentationModel": "#/components/schemas/UnknownTypePermissionPresentationModel"
|
|
}
|
|
}
|
|
},
|
|
"UnlockUsersRequestModel": {
|
|
"required": [
|
|
"userIds"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"userIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UnpublishDocumentRequestModel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"cultures": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateDataTypeRequestModel": {
|
|
"required": [
|
|
"editorAlias",
|
|
"editorUiAlias",
|
|
"name",
|
|
"values"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"editorAlias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"editorUiAlias": {
|
|
"type": "string"
|
|
},
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DataTypePropertyPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateDictionaryItemRequestModel": {
|
|
"required": [
|
|
"name",
|
|
"translations"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"translations": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DictionaryItemTranslationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateDocumentBlueprintRequestModel": {
|
|
"required": [
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentValueModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateDocumentNotificationsRequestModel": {
|
|
"required": [
|
|
"subscribedActionIds"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"subscribedActionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateDocumentRequestModel": {
|
|
"required": [
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentValueModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"template": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateDocumentTypePropertyTypeContainerRequestModel": {
|
|
"required": [
|
|
"id",
|
|
"sortOrder",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateDocumentTypePropertyTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"appearance",
|
|
"dataType",
|
|
"id",
|
|
"name",
|
|
"sortOrder",
|
|
"validation",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"container": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"dataType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"validation": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeValidationModel"
|
|
}
|
|
]
|
|
},
|
|
"appearance": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateDocumentTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"allowedAsRoot",
|
|
"allowedDocumentTypes",
|
|
"allowedTemplates",
|
|
"cleanup",
|
|
"compositions",
|
|
"containers",
|
|
"icon",
|
|
"isElement",
|
|
"name",
|
|
"properties",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"allowedAsRoot": {
|
|
"type": "boolean"
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
},
|
|
"properties": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentTypePropertyTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"containers": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateDocumentTypePropertyTypeContainerRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"allowedTemplates": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultTemplate": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"cleanup": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeCleanupModel"
|
|
}
|
|
]
|
|
},
|
|
"allowedDocumentTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeSortModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"compositions": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentTypeCompositionModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateDomainsRequestModel": {
|
|
"required": [
|
|
"domains"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"defaultIsoCode": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"domains": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DomainPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateFolderResponseModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateLanguageRequestModel": {
|
|
"required": [
|
|
"isDefault",
|
|
"isMandatory",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"isDefault": {
|
|
"type": "boolean"
|
|
},
|
|
"isMandatory": {
|
|
"type": "boolean"
|
|
},
|
|
"fallbackIsoCode": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateMediaRequestModel": {
|
|
"required": [
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaValueModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaVariantRequestModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateMediaTypePropertyTypeContainerRequestModel": {
|
|
"required": [
|
|
"id",
|
|
"sortOrder",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateMediaTypePropertyTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"appearance",
|
|
"dataType",
|
|
"id",
|
|
"name",
|
|
"sortOrder",
|
|
"validation",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"container": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"dataType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"validation": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeValidationModel"
|
|
}
|
|
]
|
|
},
|
|
"appearance": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateMediaTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"allowedAsRoot",
|
|
"allowedMediaTypes",
|
|
"compositions",
|
|
"containers",
|
|
"icon",
|
|
"isElement",
|
|
"name",
|
|
"properties",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"allowedAsRoot": {
|
|
"type": "boolean"
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
},
|
|
"properties": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMediaTypePropertyTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"containers": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMediaTypePropertyTypeContainerRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"allowedMediaTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeSortModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"compositions": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MediaTypeCompositionModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateMemberGroupRequestModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateMemberRequestModel": {
|
|
"required": [
|
|
"email",
|
|
"isApproved",
|
|
"isLockedOut",
|
|
"isTwoFactorEnabled",
|
|
"username",
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberValueModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberVariantRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"oldPassword": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"newPassword": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"nullable": true
|
|
},
|
|
"isApproved": {
|
|
"type": "boolean"
|
|
},
|
|
"isLockedOut": {
|
|
"type": "boolean"
|
|
},
|
|
"isTwoFactorEnabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateMemberTypePropertyTypeContainerRequestModel": {
|
|
"required": [
|
|
"id",
|
|
"sortOrder",
|
|
"type"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"parent": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateMemberTypePropertyTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"appearance",
|
|
"dataType",
|
|
"id",
|
|
"isSensitive",
|
|
"name",
|
|
"sortOrder",
|
|
"validation",
|
|
"variesByCulture",
|
|
"variesBySegment",
|
|
"visibility"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"container": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"sortOrder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"dataType": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"validation": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeValidationModel"
|
|
}
|
|
]
|
|
},
|
|
"appearance": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PropertyTypeAppearanceModel"
|
|
}
|
|
]
|
|
},
|
|
"isSensitive": {
|
|
"type": "boolean"
|
|
},
|
|
"visibility": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypePropertyTypeVisibilityModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateMemberTypeRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"allowedAsRoot",
|
|
"compositions",
|
|
"containers",
|
|
"icon",
|
|
"isElement",
|
|
"name",
|
|
"properties",
|
|
"variesByCulture",
|
|
"variesBySegment"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"icon": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"allowedAsRoot": {
|
|
"type": "boolean"
|
|
},
|
|
"variesByCulture": {
|
|
"type": "boolean"
|
|
},
|
|
"variesBySegment": {
|
|
"type": "boolean"
|
|
},
|
|
"collection": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"isElement": {
|
|
"type": "boolean"
|
|
},
|
|
"properties": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberTypePropertyTypeRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"containers": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UpdateMemberTypePropertyTypeContainerRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"compositions": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/MemberTypeCompositionModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdatePackageRequestModel": {
|
|
"required": [
|
|
"contentLoadChildNodes",
|
|
"dataTypes",
|
|
"dictionaryItems",
|
|
"documentTypes",
|
|
"languages",
|
|
"mediaIds",
|
|
"mediaLoadChildNodes",
|
|
"mediaTypes",
|
|
"name",
|
|
"packagePath",
|
|
"partialViews",
|
|
"scripts",
|
|
"stylesheets",
|
|
"templates"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"contentNodeId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"contentLoadChildNodes": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"mediaLoadChildNodes": {
|
|
"type": "boolean"
|
|
},
|
|
"documentTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"mediaTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"dataTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"templates": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"partialViews": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"stylesheets": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"scripts": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"languages": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"dictionaryItems": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"packagePath": {
|
|
"type": "string",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdatePartialViewRequestModel": {
|
|
"required": [
|
|
"content"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateScriptRequestModel": {
|
|
"required": [
|
|
"content"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateStylesheetRequestModel": {
|
|
"required": [
|
|
"content"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateTemplateRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateUserDataRequestModel": {
|
|
"required": [
|
|
"group",
|
|
"identifier",
|
|
"key",
|
|
"value"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"identifier": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateUserGroupRequestModel": {
|
|
"required": [
|
|
"alias",
|
|
"documentRootAccess",
|
|
"fallbackPermissions",
|
|
"hasAccessToAllLanguages",
|
|
"languages",
|
|
"mediaRootAccess",
|
|
"name",
|
|
"permissions",
|
|
"sections"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"sections": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"languages": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"hasAccessToAllLanguages": {
|
|
"type": "boolean"
|
|
},
|
|
"documentStartNode": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"documentRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaStartNode": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"mediaRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"fallbackPermissions": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"permissions": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentPermissionPresentationModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DocumentPropertyValuePermissionPresentationModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UnknownTypePermissionPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateUserGroupsOnUserRequestModel": {
|
|
"required": [
|
|
"userGroupIds",
|
|
"userIds"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"userIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"userGroupIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateUserRequestModel": {
|
|
"required": [
|
|
"documentStartNodeIds",
|
|
"email",
|
|
"hasDocumentRootAccess",
|
|
"hasMediaRootAccess",
|
|
"languageIsoCode",
|
|
"mediaStartNodeIds",
|
|
"name",
|
|
"userGroupIds",
|
|
"userName"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"userName": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"userGroupIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"languageIsoCode": {
|
|
"type": "string"
|
|
},
|
|
"documentStartNodeIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"hasDocumentRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaStartNodeIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"hasMediaRootAccess": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpdateWebhookRequestModel": {
|
|
"required": [
|
|
"contentTypeKeys",
|
|
"enabled",
|
|
"events",
|
|
"headers",
|
|
"url"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"url": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"contentTypeKeys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpgradeCheckResponseModel": {
|
|
"required": [
|
|
"comment",
|
|
"type",
|
|
"url"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"comment": {
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UpgradeSettingsResponseModel": {
|
|
"required": [
|
|
"currentState",
|
|
"newState",
|
|
"newVersion",
|
|
"oldVersion",
|
|
"reportUrl"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"currentState": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"newState": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"newVersion": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"oldVersion": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"reportUrl": {
|
|
"type": "string",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserConfigurationResponseModel": {
|
|
"required": [
|
|
"allowChangePassword",
|
|
"allowTwoFactor",
|
|
"canInviteUsers",
|
|
"passwordConfiguration",
|
|
"usernameIsEmail"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"canInviteUsers": {
|
|
"type": "boolean"
|
|
},
|
|
"usernameIsEmail": {
|
|
"type": "boolean"
|
|
},
|
|
"passwordConfiguration": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PasswordConfigurationResponseModel"
|
|
}
|
|
]
|
|
},
|
|
"allowChangePassword": {
|
|
"type": "boolean"
|
|
},
|
|
"allowTwoFactor": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserDataModel": {
|
|
"required": [
|
|
"group",
|
|
"identifier",
|
|
"value"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"identifier": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserDataOperationStatusModel": {
|
|
"enum": [
|
|
"Success",
|
|
"NotFound",
|
|
"UserNotFound",
|
|
"AlreadyExists"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"UserDataResponseModel": {
|
|
"required": [
|
|
"group",
|
|
"identifier",
|
|
"key",
|
|
"value"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"identifier": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserExternalLoginProviderModel": {
|
|
"required": [
|
|
"hasManualLinkingEnabled",
|
|
"isLinkedOnUser",
|
|
"providerSchemeName"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"providerSchemeName": {
|
|
"type": "string"
|
|
},
|
|
"providerKey": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"isLinkedOnUser": {
|
|
"type": "boolean"
|
|
},
|
|
"hasManualLinkingEnabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserGroupItemResponseModel": {
|
|
"required": [
|
|
"flags",
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"alias": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserGroupResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"aliasCanBeChanged",
|
|
"documentRootAccess",
|
|
"fallbackPermissions",
|
|
"hasAccessToAllLanguages",
|
|
"id",
|
|
"isDeletable",
|
|
"languages",
|
|
"mediaRootAccess",
|
|
"name",
|
|
"permissions",
|
|
"sections"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"sections": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"languages": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"hasAccessToAllLanguages": {
|
|
"type": "boolean"
|
|
},
|
|
"documentStartNode": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"documentRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaStartNode": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"mediaRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"fallbackPermissions": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"permissions": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentPermissionPresentationModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DocumentPropertyValuePermissionPresentationModel"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/UnknownTypePermissionPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"isDeletable": {
|
|
"type": "boolean"
|
|
},
|
|
"aliasCanBeChanged": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserInstallRequestModel": {
|
|
"required": [
|
|
"email",
|
|
"name",
|
|
"password",
|
|
"subscribeToNewsletter"
|
|
],
|
|
"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"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserItemResponseModel": {
|
|
"required": [
|
|
"avatarUrls",
|
|
"flags",
|
|
"id",
|
|
"kind",
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"avatarUrls": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"kind": {
|
|
"$ref": "#/components/schemas/UserKindModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserKindModel": {
|
|
"enum": [
|
|
"Default",
|
|
"Api"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"UserOrderModel": {
|
|
"enum": [
|
|
"UserName",
|
|
"Language",
|
|
"Name",
|
|
"Email",
|
|
"Id",
|
|
"CreateDate",
|
|
"UpdateDate",
|
|
"IsApproved",
|
|
"IsLockedOut",
|
|
"LastLoginDate"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"UserPermissionModel": {
|
|
"required": [
|
|
"nodeKey",
|
|
"permissions"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"nodeKey": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"permissions": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserPermissionsResponseModel": {
|
|
"required": [
|
|
"permissions"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/UserPermissionModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserResponseModel": {
|
|
"required": [
|
|
"avatarUrls",
|
|
"createDate",
|
|
"documentStartNodeIds",
|
|
"email",
|
|
"failedLoginAttempts",
|
|
"hasDocumentRootAccess",
|
|
"hasMediaRootAccess",
|
|
"id",
|
|
"isAdmin",
|
|
"kind",
|
|
"mediaStartNodeIds",
|
|
"name",
|
|
"state",
|
|
"updateDate",
|
|
"userGroupIds",
|
|
"userName"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"userName": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"userGroupIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"languageIsoCode": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"documentStartNodeIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"hasDocumentRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"mediaStartNodeIds": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"hasMediaRootAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"avatarUrls": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"state": {
|
|
"$ref": "#/components/schemas/UserStateModel"
|
|
},
|
|
"failedLoginAttempts": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"createDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"updateDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"lastLoginDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"lastLockoutDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"lastPasswordChangeDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"nullable": true
|
|
},
|
|
"isAdmin": {
|
|
"type": "boolean"
|
|
},
|
|
"kind": {
|
|
"$ref": "#/components/schemas/UserKindModel"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserSettingsPresentationModel": {
|
|
"required": [
|
|
"consentLevels",
|
|
"minCharLength",
|
|
"minNonAlphaNumericLength"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"minCharLength": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"minNonAlphaNumericLength": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"consentLevels": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ConsentLevelPresentationModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"UserStateModel": {
|
|
"enum": [
|
|
"Active",
|
|
"Disabled",
|
|
"LockedOut",
|
|
"Invited",
|
|
"Inactive",
|
|
"All"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"UserTwoFactorProviderModel": {
|
|
"required": [
|
|
"isEnabledOnUser",
|
|
"providerName"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"providerName": {
|
|
"type": "string"
|
|
},
|
|
"isEnabledOnUser": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ValidateUpdateDocumentRequestModel": {
|
|
"required": [
|
|
"values",
|
|
"variants"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentValueModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"variants": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/DocumentVariantRequestModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"template": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"cultures": {
|
|
"uniqueItems": true,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"VariantItemResponseModel": {
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"culture": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"VerifyInviteUserRequestModel": {
|
|
"required": [
|
|
"token",
|
|
"user"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"user": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"token": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"VerifyInviteUserResponseModel": {
|
|
"required": [
|
|
"passwordConfiguration"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"passwordConfiguration": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PasswordConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"VerifyResetPasswordResponseModel": {
|
|
"required": [
|
|
"passwordConfiguration"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"passwordConfiguration": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/PasswordConfigurationResponseModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"VerifyResetPasswordTokenRequestModel": {
|
|
"required": [
|
|
"resetCode",
|
|
"user"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"user": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReferenceByIdModel"
|
|
}
|
|
]
|
|
},
|
|
"resetCode": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"WebhookEventModel": {
|
|
"required": [
|
|
"alias",
|
|
"eventName",
|
|
"eventType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"eventName": {
|
|
"type": "string"
|
|
},
|
|
"eventType": {
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"WebhookEventResponseModel": {
|
|
"required": [
|
|
"alias",
|
|
"eventName",
|
|
"eventType"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"eventName": {
|
|
"type": "string"
|
|
},
|
|
"eventType": {
|
|
"type": "string"
|
|
},
|
|
"alias": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"WebhookItemResponseModel": {
|
|
"required": [
|
|
"enabled",
|
|
"events",
|
|
"flags",
|
|
"id",
|
|
"name",
|
|
"types",
|
|
"url"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/FlagModel"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"events": {
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"types": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"WebhookLogResponseModel": {
|
|
"required": [
|
|
"date",
|
|
"eventAlias",
|
|
"exceptionOccured",
|
|
"isSuccessStatusCode",
|
|
"key",
|
|
"requestBody",
|
|
"requestHeaders",
|
|
"responseBody",
|
|
"responseHeaders",
|
|
"retryCount",
|
|
"statusCode",
|
|
"url",
|
|
"webhookKey"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"key": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"webhookKey": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"statusCode": {
|
|
"type": "string"
|
|
},
|
|
"isSuccessStatusCode": {
|
|
"type": "boolean"
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"eventAlias": {
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"retryCount": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"requestHeaders": {
|
|
"type": "string"
|
|
},
|
|
"requestBody": {
|
|
"type": "string"
|
|
},
|
|
"responseHeaders": {
|
|
"type": "string"
|
|
},
|
|
"responseBody": {
|
|
"type": "string"
|
|
},
|
|
"exceptionOccured": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"WebhookResponseModel": {
|
|
"required": [
|
|
"contentTypeKeys",
|
|
"enabled",
|
|
"events",
|
|
"headers",
|
|
"id",
|
|
"url"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"url": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"contentTypeKeys": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/WebhookEventResponseModel"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"securitySchemes": {
|
|
"Backoffice-User": {
|
|
"type": "oauth2",
|
|
"description": "Umbraco Authentication",
|
|
"flows": {
|
|
"authorizationCode": {
|
|
"authorizationUrl": "/umbraco/management/api/v1/security/back-office/authorize",
|
|
"tokenUrl": "/umbraco/management/api/v1/security/back-office/token",
|
|
"scopes": { }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "Culture"
|
|
},
|
|
{
|
|
"name": "Data Type"
|
|
},
|
|
{
|
|
"name": "Dictionary"
|
|
},
|
|
{
|
|
"name": "Document Blueprint"
|
|
},
|
|
{
|
|
"name": "Document Type"
|
|
},
|
|
{
|
|
"name": "Document Version"
|
|
},
|
|
{
|
|
"name": "Document"
|
|
},
|
|
{
|
|
"name": "Dynamic Root"
|
|
},
|
|
{
|
|
"name": "Health Check"
|
|
},
|
|
{
|
|
"name": "Help"
|
|
},
|
|
{
|
|
"name": "Imaging"
|
|
},
|
|
{
|
|
"name": "Import"
|
|
},
|
|
{
|
|
"name": "Indexer"
|
|
},
|
|
{
|
|
"name": "Install"
|
|
},
|
|
{
|
|
"name": "Language"
|
|
},
|
|
{
|
|
"name": "Log Viewer"
|
|
},
|
|
{
|
|
"name": "Manifest"
|
|
},
|
|
{
|
|
"name": "Media Type"
|
|
},
|
|
{
|
|
"name": "Media"
|
|
},
|
|
{
|
|
"name": "Member Group"
|
|
},
|
|
{
|
|
"name": "Member Type"
|
|
},
|
|
{
|
|
"name": "Member"
|
|
},
|
|
{
|
|
"name": "Models Builder"
|
|
},
|
|
{
|
|
"name": "News Dashboard"
|
|
},
|
|
{
|
|
"name": "Object Types"
|
|
},
|
|
{
|
|
"name": "oEmbed"
|
|
},
|
|
{
|
|
"name": "Package"
|
|
},
|
|
{
|
|
"name": "Partial View"
|
|
},
|
|
{
|
|
"name": "Preview"
|
|
},
|
|
{
|
|
"name": "Profiling"
|
|
},
|
|
{
|
|
"name": "Property Type"
|
|
},
|
|
{
|
|
"name": "Published Cache"
|
|
},
|
|
{
|
|
"name": "Redirect Management"
|
|
},
|
|
{
|
|
"name": "Relation Type"
|
|
},
|
|
{
|
|
"name": "Relation"
|
|
},
|
|
{
|
|
"name": "Script"
|
|
},
|
|
{
|
|
"name": "Searcher"
|
|
},
|
|
{
|
|
"name": "Security"
|
|
},
|
|
{
|
|
"name": "Segment"
|
|
},
|
|
{
|
|
"name": "Server"
|
|
},
|
|
{
|
|
"name": "Static File"
|
|
},
|
|
{
|
|
"name": "Stylesheet"
|
|
},
|
|
{
|
|
"name": "Tag"
|
|
},
|
|
{
|
|
"name": "Telemetry"
|
|
},
|
|
{
|
|
"name": "Template"
|
|
},
|
|
{
|
|
"name": "Temporary File"
|
|
},
|
|
{
|
|
"name": "Upgrade"
|
|
},
|
|
{
|
|
"name": "User Data"
|
|
},
|
|
{
|
|
"name": "User Group"
|
|
},
|
|
{
|
|
"name": "User"
|
|
},
|
|
{
|
|
"name": "Webhook"
|
|
}
|
|
]
|
|
}
|