{ "openapi": "3.0.4", "info": { "title": "The Zentrum API", "version": "v1" }, "paths": { "/v1/api/javascript-sdk": { "get": { "tags": [ "Api" ], "summary": "Api_JavascriptSdk_Summary", "description": "Api_JavascriptSdk_Description", "parameters": [ { "name": "CreateInterface", "in": "query", "description": "", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user" ] } ] } }, "/v1/app/get": { "get": { "tags": [ "App" ], "summary": "App_GetApps_Summary", "description": "App_GetApps_Description", "parameters": [ { "name": "AppZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Filter", "in": "query", "description": "[Enum_unspecified, Enum_all, Enum_my_organization_apps]", "schema": { "$ref": "#/components/schemas/GetAppsRequest_AppFilter" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAppsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://app:read" ] } ] } }, "/v1/app/create-proposal": { "post": { "tags": [ "App" ], "summary": "App_CreateAppProposal_Summary", "description": "App_CreateAppProposal_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppProposalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAppProposalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAppProposalRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppProposalResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://app:create" ] } ] } }, "/v1/app/get-proposals": { "get": { "tags": [ "App" ], "summary": "App_GetAppProposals_Summary", "description": "App_GetAppProposals_Description", "parameters": [ { "name": "ProposalZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "AppZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAppProposalsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://app:read" ] } ] } }, "/v1/app/update-proposal": { "put": { "tags": [ "App" ], "summary": "App_UpdateAppProposal_Summary", "description": "App_UpdateAppProposal_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppProposalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAppProposalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAppProposalRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppProposalResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://app:update" ] } ] } }, "/v1/app/promote-proposal": { "post": { "tags": [ "App" ], "summary": "App_PromoteAppProposal_Summary", "description": "App_PromoteAppProposal_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromoteAppProposalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PromoteAppProposalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PromoteAppProposalRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromoteAppProposalResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://app:update" ] } ] } }, "/v1/app/delete-proposal": { "delete": { "tags": [ "App" ], "summary": "App_DeleteAppProposal_Summary", "description": "App_DeleteAppProposal_Description", "parameters": [ { "name": "ProposalZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAppProposalResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://app:delete" ] } ] } }, "/v1/app/submit-proposal": { "post": { "tags": [ "App" ], "summary": "App_SubmitAppProposal_Summary", "description": "App_SubmitAppProposal_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitAppProposalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubmitAppProposalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubmitAppProposalRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitAppProposalResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://app:update" ] } ] } }, "/v1/app/delete": { "delete": { "tags": [ "App" ], "summary": "App_DeleteApp_Summary", "description": "App_DeleteApp_Description", "parameters": [ { "name": "AppZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Proposal", "in": "query", "description": "", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAppResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://app:delete" ] } ] } }, "/v1/app/generate-secret": { "post": { "tags": [ "App" ], "summary": "App_GenerateAppSecret_Summary", "description": "App_GenerateAppSecret_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateAppSecretRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenerateAppSecretRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenerateAppSecretRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateAppSecretResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://app:update" ] } ] } }, "/v1/app/get-scopes": { "get": { "tags": [ "App" ], "summary": "App_GetScopes_Summary", "description": "App_GetScopes_Description", "parameters": [ { "name": "Name", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "StartsWith", "in": "query", "description": "", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetScopesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://app:read" ] } ] } }, "/v1/asset/request-upload": { "post": { "tags": [ "Asset" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestUploadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RequestUploadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RequestUploadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestUploadResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user" ] } ] } }, "/v1/asset/confirm": { "post": { "tags": [ "Asset" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmUploadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfirmUploadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConfirmUploadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmUploadResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user" ] } ] } }, "/v1/asset/get": { "get": { "tags": [ "Asset" ], "parameters": [ { "name": "asset_zid", "in": "query", "schema": { "type": "string" } } ], "responses": { "302": { "description": "Found" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "role://user" ] } ] } }, "/v1/asset/get-metadata": { "get": { "tags": [ "Asset" ], "parameters": [ { "name": "asset_zid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAssetMetadataResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user" ] } ] } }, "/v1/asset/delete": { "delete": { "tags": [ "Asset" ], "parameters": [ { "name": "asset_zid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAssetResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user" ] } ] } }, "/v1/asset/list": { "get": { "tags": [ "Asset" ], "parameters": [ { "name": "entity_zid", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAssetsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user" ] } ] } }, "/v1/asset/link": { "post": { "tags": [ "Asset" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkAssetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LinkAssetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LinkAssetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkAssetResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user" ] } ] } }, "/v1/asset/unlink": { "delete": { "tags": [ "Asset" ], "parameters": [ { "name": "asset_zid", "in": "query", "schema": { "type": "string" } }, { "name": "entity_zid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlinkAssetResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user" ] } ] } }, "/v1/bot/get": { "get": { "tags": [ "Bot" ], "summary": "Bot_GetBots_Summary", "description": "Bot_GetBots_Description", "parameters": [ { "name": "BotUserZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Username", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "SearchText", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "OwnerType", "in": "query", "description": "[Unspecified, Personal, Organization, System]", "schema": { "$ref": "#/components/schemas/BotOwnerType" } }, { "name": "OwnerUserZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "OwnerOrganizationZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "IncludeCredentials", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBotsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://bot:read" ] } ] } }, "/v1/bot/create": { "post": { "tags": [ "Bot" ], "summary": "Bot_CreateBot_Summary", "description": "Bot_CreateBot_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBotRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBotRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBotRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBotResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://bot:create" ] } ] } }, "/v1/bot/update": { "put": { "tags": [ "Bot" ], "summary": "Bot_UpdateBot_Summary", "description": "Bot_UpdateBot_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBotRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBotRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBotRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBotResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://bot:update" ] } ] } }, "/v1/bot/set-enabled": { "post": { "tags": [ "Bot" ], "summary": "Bot_SetBotEnabled_Summary", "description": "Bot_SetBotEnabled_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetBotEnabledRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetBotEnabledRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetBotEnabledRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetBotEnabledResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://bot:update" ] } ] } }, "/v1/bot/get-credentials": { "get": { "tags": [ "Bot" ], "summary": "Bot_GetBotCredentials_Summary", "description": "Bot_GetBotCredentials_Description", "parameters": [ { "name": "BotUserZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBotCredentialsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://bot:read" ] } ] } }, "/v1/bot/create-credential": { "post": { "tags": [ "Bot" ], "summary": "Bot_CreateBotCredential_Summary", "description": "Bot_CreateBotCredential_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBotCredentialRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBotCredentialRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBotCredentialRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBotCredentialResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://bot:update" ] } ] } }, "/v1/bot/revoke-credential": { "post": { "tags": [ "Bot" ], "summary": "Bot_RevokeBotCredential_Summary", "description": "Bot_RevokeBotCredential_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeBotCredentialRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevokeBotCredentialRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevokeBotCredentialRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeBotCredentialResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://bot:update" ] } ] } }, "/v1/bot/send-email-verification": { "post": { "tags": [ "Bot" ], "summary": "Bot_SendBotEmailVerification_Summary", "description": "Bot_SendBotEmailVerification_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendBotEmailVerificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendBotEmailVerificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendBotEmailVerificationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendBotEmailVerificationResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://bot:update" ] } ] } }, "/v1/bot/delete": { "delete": { "tags": [ "Bot" ], "summary": "Bot_DeleteBot_Summary", "description": "Bot_DeleteBot_Description", "parameters": [ { "name": "BotUserZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteBotResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://bot:delete" ] } ] } }, "/v1/content/collection/create": { "post": { "tags": [ "Collection" ], "summary": "Collection_Create_Summary", "description": "Collection_Create_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCollectionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCollectionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCollectionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCollectionResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:create" ] } ] } }, "/v1/content/collection/update": { "put": { "tags": [ "Collection" ], "summary": "Collection_Update_Summary", "description": "Collection_Update_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCollectionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCollectionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCollectionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCollectionResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/collection/get-documents": { "get": { "tags": [ "Collection" ], "summary": "Collection_GetDocuments_Summary", "description": "Collection_GetDocuments_Description", "parameters": [ { "name": "ContentZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "ReadDraft", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "Query", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectionDocumentsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:read" ] } ] } }, "/v1/content/collection/insert-document": { "post": { "tags": [ "Collection" ], "summary": "Collection_InsertDocument_Summary", "description": "Collection_InsertDocument_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertCollectionDocumentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InsertCollectionDocumentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InsertCollectionDocumentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertCollectionDocumentResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:create" ] } ] } }, "/v1/content/collection/update-document": { "put": { "tags": [ "Collection" ], "summary": "Collection_UpdateDocument_Summary", "description": "Collection_UpdateDocument_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCollectionDocumentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCollectionDocumentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCollectionDocumentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCollectionDocumentResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/collection/delete-document": { "delete": { "tags": [ "Collection" ], "summary": "Collection_DeleteDocument_Summary", "description": "Collection_DeleteDocument_Description", "parameters": [ { "name": "ContentZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "DocumentZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCollectionDocumentResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:delete" ] } ] } }, "/v1/content/comment/get-threads": { "get": { "tags": [ "Comment" ], "summary": "Comment_GetThreads_Summary", "description": "Comment_GetThreads_Description", "parameters": [ { "name": "ContentZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "DocumentZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "ThreadZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "IncludeResolved", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "PageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCommentThreadsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:read" ] } ] } }, "/v1/content/comment/get-comments": { "get": { "tags": [ "Comment" ], "summary": "Comment_GetComments_Summary", "description": "Comment_GetComments_Description", "parameters": [ { "name": "ThreadZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "PageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCommentsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:read" ] } ] } }, "/v1/content/comment/create-comment": { "post": { "tags": [ "Comment" ], "summary": "Comment_CreateComment_Summary", "description": "Comment_CreateComment_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCommentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommentResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/comment/update-comment": { "put": { "tags": [ "Comment" ], "summary": "Comment_UpdateComment_Summary", "description": "Comment_UpdateComment_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCommentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCommentResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/comment/delete-comment": { "delete": { "tags": [ "Comment" ], "summary": "Comment_DeleteComment_Summary", "description": "Comment_DeleteComment_Description", "parameters": [ { "name": "CommentZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCommentResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/comment/resolve-thread": { "post": { "tags": [ "Comment" ], "summary": "Comment_ResolveThread_Summary", "description": "Comment_ResolveThread_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveCommentThreadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveCommentThreadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResolveCommentThreadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveCommentThreadResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/comment/reopen-thread": { "post": { "tags": [ "Comment" ], "summary": "Comment_ReopenThread_Summary", "description": "Comment_ReopenThread_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReopenCommentThreadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReopenCommentThreadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReopenCommentThreadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReopenCommentThreadResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/comment/toggle-reaction": { "post": { "tags": [ "Comment" ], "summary": "Comment_ToggleReaction_Summary", "description": "Comment_ToggleReaction_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToggleCommentReactionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ToggleCommentReactionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ToggleCommentReactionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToggleCommentReactionResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/delete": { "delete": { "tags": [ "Content" ], "summary": "Content_DeleteContent_Summary", "description": "Content_DeleteContent_Description", "parameters": [ { "name": "ContentZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteContentResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:delete" ] } ] } }, "/v1/content/set-user-tag": { "post": { "tags": [ "Content" ], "summary": "Content_SetContentUserTag_Summary", "description": "Content_SetContentUserTag_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetContentUserTagRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetContentUserTagRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetContentUserTagRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetContentUserTagResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/get-user-tagged": { "get": { "tags": [ "Content" ], "summary": "Content_GetUserTaggedContent_Summary", "description": "Content_GetUserTaggedContent_Description", "parameters": [ { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Tag", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserTaggedContentResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:read" ] } ] } }, "/v1/content/save": { "post": { "tags": [ "Content" ], "summary": "Content_SaveContent_Summary", "description": "Content_SaveContent_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveContentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveContentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveContentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveContentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveContentResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveContentResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveContentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveContentResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveContentResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveContentResponse" } } } } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/get-metadata": { "get": { "tags": [ "Content" ], "summary": "Content_GetContentMetadata_Summary", "description": "Content_GetContentMetadata_Description", "parameters": [ { "name": "SpaceZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "TemplateZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Kind", "in": "query", "description": "[Enum_unspecified, Enum_document, Enum_collection, Enum_file]", "schema": { "$ref": "#/components/schemas/ContentKind" } }, { "name": "OwnerUserZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "HasSaved", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "HasDraft", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetContentMetadataResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:read" ] } ] } }, "/v1/content/collaboration/join": { "post": { "tags": [ "Content" ], "parameters": [ { "name": "content_zid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JoinContentCollaborationResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/collaboration/leave": { "post": { "tags": [ "Content" ], "parameters": [ { "name": "content_zid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaveContentCollaborationResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/collaboration/edit": { "post": { "tags": [ "Content" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyEditRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplyEditRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplyEditRequestModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyEditResponseModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/content/document/create": { "post": { "tags": [ "Document" ], "summary": "Document_Create_Summary", "description": "Document_Create_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocumentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDocumentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDocumentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocumentResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:create" ] } ] } }, "/v1/content/document/get": { "get": { "tags": [ "Document" ], "summary": "Document_Get_Summary", "description": "Document_Get_Description", "parameters": [ { "name": "ContentZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "ReadDraft", "in": "query", "description": "", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:read" ] } ] } }, "/v1/content/document/update": { "put": { "tags": [ "Document" ], "summary": "Document_Update_Summary", "description": "Document_Update_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDocumentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDocumentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDocumentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDocumentResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/drive/get": { "get": { "tags": [ "Drive" ], "summary": "Drive_GetDrive_Summary", "description": "Drive_GetDrive_Description", "parameters": [ { "name": "DriveZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDriveResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:read" ] } ] } }, "/v1/drive/list": { "get": { "tags": [ "Drive" ], "summary": "Drive_ListDrives_Summary", "description": "Drive_ListDrives_Description", "parameters": [ { "name": "Mode", "in": "query", "description": "[Enum_visible, Enum_admin]", "schema": { "$ref": "#/components/schemas/DriveListMode" } }, { "name": "OwnerEntityZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDrivesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:read" ] } ] } }, "/v1/drive/create": { "post": { "tags": [ "Drive" ], "summary": "Drive_CreateDrive_Summary", "description": "Drive_CreateDrive_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDriveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDriveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDriveRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDriveResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:create" ] } ] } }, "/v1/drive/update": { "put": { "tags": [ "Drive" ], "summary": "Drive_UpdateDrive_Summary", "description": "Drive_UpdateDrive_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDriveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDriveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDriveRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDriveResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:update" ] } ] } }, "/v1/drive/delete": { "delete": { "tags": [ "Drive" ], "summary": "Drive_DeleteDrive_Summary", "description": "Drive_DeleteDrive_Description", "parameters": [ { "name": "DriveZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDriveResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:delete" ] } ] } }, "/v1/entity/get": { "get": { "tags": [ "Entity" ], "summary": "Entity_GetEntitySummary_Summary", "description": "Entity_GetEntitySummary_Description", "parameters": [ { "name": "Zid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Q", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Type", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEntitySummaryResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "scope://entity:read" ] } ] } }, "/v1/entity/get-recently-accessed": { "get": { "tags": [ "Entity" ], "summary": "Entity_GetRecentlyAccessed_Summary", "description": "Entity_GetRecentlyAccessed_Description", "parameters": [ { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "ZidTypes", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "AppZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "AccessType", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "SinceTime", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRecentlyAccessedResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "scope://entity:read" ] } ] } }, "/v1/layout/create": { "post": { "tags": [ "Layout" ], "summary": "Layout_CreateLayout_Summary", "description": "Layout_CreateLayout_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLayoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLayoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLayoutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLayoutResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://layout:create" ] } ] } }, "/v1/layout/get": { "get": { "tags": [ "Layout" ], "summary": "Layout_GetLayout_Summary", "description": "Layout_GetLayout_Description", "parameters": [ { "name": "LayoutZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLayoutResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://layout:read" ] } ] } }, "/v1/layout/list": { "get": { "tags": [ "Layout" ], "summary": "Layout_ListLayouts_Summary", "description": "Layout_ListLayouts_Description", "parameters": [ { "name": "OrgZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLayoutsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://layout:read" ] } ] } }, "/v1/layout/update": { "put": { "tags": [ "Layout" ], "summary": "Layout_UpdateLayout_Summary", "description": "Layout_UpdateLayout_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLayoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLayoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLayoutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLayoutResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://layout:update" ] } ] } }, "/v1/layout/delete": { "delete": { "tags": [ "Layout" ], "summary": "Layout_DeleteLayout_Summary", "description": "Layout_DeleteLayout_Description", "parameters": [ { "name": "LayoutZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLayoutResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://layout:delete" ] } ] } }, "/v1/layout/regenerate": { "post": { "tags": [ "Layout" ], "summary": "Layout_RegenerateLayouts_Summary", "description": "Layout_RegenerateLayouts_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegenerateLayoutsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegenerateLayoutsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegenerateLayoutsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegenerateLayoutsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://layout:create" ] } ] } }, "/v1/layout/metadata": { "get": { "tags": [ "Layout" ], "summary": "Layout_GetLayoutDslMetadata_Summary", "description": "Layout_GetLayoutDslMetadata_Description", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLayoutDslMetadataResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://layout:read" ] } ] } }, "/v1/layout/compatible": { "get": { "tags": [ "Layout" ], "summary": "Layout_GetCompatibleLayouts_Summary", "description": "Layout_GetCompatibleLayouts_Description", "parameters": [ { "name": "TemplateZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCompatibleLayoutsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://layout:read" ] } ] } }, "/v1/layout/set-content-layout": { "post": { "tags": [ "Layout" ], "summary": "Layout_SetContentLayout_Summary", "description": "Layout_SetContentLayout_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetContentLayoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetContentLayoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetContentLayoutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetContentLayoutResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/layout/content-layout": { "get": { "tags": [ "Layout" ], "summary": "Layout_GetContentLayout_Summary", "description": "Layout_GetContentLayout_Description", "parameters": [ { "name": "ContentZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetContentLayoutResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:read" ] } ] } }, "/v1/layout/reset-content-layout": { "delete": { "tags": [ "Layout" ], "summary": "Layout_ResetContentLayout_Summary", "description": "Layout_ResetContentLayout_Description", "parameters": [ { "name": "ContentZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetContentLayoutResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://content:update" ] } ] } }, "/v1/notification/get-notifications": { "get": { "tags": [ "Notification" ], "summary": "Notification_GetNotifications_Summary", "description": "Notification_GetNotifications_Description", "parameters": [ { "name": "Category", "in": "query", "description": "[Unspecified, ContentSaved, DocumentShared, SpaceShared, PermissionChanged, CollaboratorJoined, WeeklyDigest, CommentMention]", "schema": { "$ref": "#/components/schemas/NotificationCategory" } }, { "name": "State", "in": "query", "description": "[Unspecified, Unread, Read, Deleted]", "schema": { "$ref": "#/components/schemas/NotificationState" } }, { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNotificationsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://notification:read" ] } ] } }, "/v1/notification/get-unread-count": { "get": { "tags": [ "Notification" ], "summary": "Notification_GetUnreadCount_Summary", "description": "Notification_GetUnreadCount_Description", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUnreadCountResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://notification:read" ] } ] } }, "/v1/notification/mark-notifications": { "put": { "tags": [ "Notification" ], "summary": "Notification_MarkNotifications_Summary", "description": "Notification_MarkNotifications_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkNotificationsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarkNotificationsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MarkNotificationsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkNotificationsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://notification:update" ] } ] } }, "/v1/notification/get-preferences": { "get": { "tags": [ "Notification" ], "summary": "Notification_GetNotificationPreferences_Summary", "description": "Notification_GetNotificationPreferences_Description", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNotificationPreferencesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://notification:read" ] } ] } }, "/v1/notification/set-preferences": { "put": { "tags": [ "Notification" ], "summary": "Notification_SetNotificationPreferences_Summary", "description": "Notification_SetNotificationPreferences_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetNotificationPreferencesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetNotificationPreferencesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetNotificationPreferencesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetNotificationPreferencesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://notification:update" ] } ] } }, "/v1/organization/get": { "get": { "tags": [ "Organization" ], "summary": "Organization_GetOrganizations_Summary", "description": "Organization_GetOrganizations_Description", "parameters": [ { "name": "OrganizationZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://organization:read" ] } ] } }, "/v1/organization/create": { "post": { "tags": [ "Organization" ], "summary": "Organization_CreateOrganization_Summary", "description": "Organization_CreateOrganization_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://organization:create" ] } ] } }, "/v1/organization/update": { "put": { "tags": [ "Organization" ], "summary": "Organization_UpdateOrganization_Summary", "description": "Organization_UpdateOrganization_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://organization:update" ] } ] } }, "/v1/organization/delete": { "delete": { "tags": [ "Organization" ], "summary": "Organization_DeleteOrganization_Summary", "description": "Organization_DeleteOrganization_Description", "parameters": [ { "name": "OrganizationZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://organization:delete" ] } ] } }, "/v1/organization/add-membership": { "post": { "tags": [ "Organization" ], "summary": "Organization_AddOrganizationMembership_Summary", "description": "Organization_AddOrganizationMembership_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrganizationMembershipRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddOrganizationMembershipRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddOrganizationMembershipRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrganizationMembershipResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://organization:update" ] } ] } }, "/v1/organization/delete-membership": { "delete": { "tags": [ "Organization" ], "summary": "Organization_DeleteOrganizationMembership_Summary", "description": "Organization_DeleteOrganizationMembership_Description", "parameters": [ { "name": "MembershipZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationMembershipResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://organization:update" ] } ] } }, "/v1/organization/get-memberships": { "get": { "tags": [ "Organization" ], "summary": "Organization_GetOrganizationMemberships_Summary", "description": "Organization_GetOrganizationMemberships_Description", "parameters": [ { "name": "OrganizationZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationMembershipsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://organization:read" ] } ] } }, "/v1/product/get": { "get": { "tags": [ "Product" ], "summary": "Product_GetProductsAsync_Summary", "description": "Product_GetProductsAsync_Description", "parameters": [ { "name": "ProductZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://product:read" ] } ] } }, "/v1/product/get-groups": { "get": { "tags": [ "Product" ], "summary": "Product_GetProductGroups_Summary", "description": "Product_GetProductGroups_Description", "parameters": [ { "name": "ProductGroupZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductGroupsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://product:read" ] } ] } }, "/v1/product/purchase": { "post": { "tags": [ "Product" ], "summary": "Product_PurchaseProduct_Summary", "description": "Product_PurchaseProduct_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseProductRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseProductRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PurchaseProductRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseProductResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://product:create" ] } ] } }, "/v1/product/get-entitlements": { "get": { "tags": [ "Product" ], "summary": "Product_GetEntitlements_Summary", "description": "Product_GetEntitlements_Description", "parameters": [ { "name": "OwnerZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "EntitlementZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEntitlementsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://product:read" ] } ] } }, "/v1/product/get-invoices": { "get": { "tags": [ "Product" ], "summary": "Product_GetInvoicesAsync_Summary", "description": "Product_GetInvoicesAsync_Description", "parameters": [ { "name": "InvoiceZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "OwnerZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "EntitlementZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "StartTime", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndTime", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInvoicesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://product:read" ] } ] } }, "/v1/product/get-usage": { "get": { "tags": [ "Product" ], "summary": "Product_GetUsage_Summary", "description": "Product_GetUsage_Description", "parameters": [ { "name": "EntityZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "StartTime", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndTime", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "Granularity", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsageResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://product:read" ] } ] } }, "/v1/space/get": { "get": { "tags": [ "Space" ], "summary": "Space_GetSpaces_Summary", "description": "Space_GetSpaces_Description", "parameters": [ { "name": "SpaceZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "SearchText", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSpacesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:read" ] } ] } }, "/v1/space/create": { "post": { "tags": [ "Space" ], "summary": "Space_CreateSpace_Summary", "description": "Space_CreateSpace_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpaceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSpaceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSpaceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpaceResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:create" ] } ] } }, "/v1/space/update": { "put": { "tags": [ "Space" ], "summary": "Space_UpdateSpace_Summary", "description": "Space_UpdateSpace_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSpaceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSpaceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSpaceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSpaceResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:update" ] } ] } }, "/v1/space/delete": { "delete": { "tags": [ "Space" ], "summary": "Space_DeleteSpace_Summary", "description": "Space_DeleteSpace_Description", "parameters": [ { "name": "SpaceZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSpaceResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:delete" ] } ] } }, "/v1/space/get-permissions": { "get": { "tags": [ "Space" ], "summary": "Space_GetPermissions_Summary", "description": "Space_GetPermissions_Description", "parameters": [ { "name": "SpaceZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "EntityZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "EntityTypeId", "in": "query", "description": "[Enum_unknown, Enum_user, Enum_app, Enum_organization, Enum_entitlement]", "schema": { "$ref": "#/components/schemas/EntityType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPermissionsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:read" ] } ] } }, "/v1/space/set-permissions": { "post": { "tags": [ "Space" ], "summary": "Space_SetPermissions_Summary", "description": "Space_SetPermissions_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPermissionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetPermissionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetPermissionsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPermissionsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:update" ] } ] } }, "/v1/space/set-user-tag": { "post": { "tags": [ "Space" ], "summary": "Space_SetSpaceUserTag_Summary", "description": "Space_SetSpaceUserTag_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetSpaceUserTagRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetSpaceUserTagRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetSpaceUserTagRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetSpaceUserTagResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:update" ] } ] } }, "/v1/space/get-user-tagged": { "get": { "tags": [ "Space" ], "summary": "Space_GetUserTaggedSpaces_Summary", "description": "Space_GetUserTaggedSpaces_Description", "parameters": [ { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Tag", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserTaggedSpacesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:read" ] } ] } }, "/v1/space/list": { "get": { "tags": [ "Space" ], "summary": "Space_ListSpace_Summary", "description": "Space_ListSpace_Description", "parameters": [ { "name": "SpaceZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "IncludeSpaces", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "IncludeSavedContent", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "IncludeDraftContent", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "Recursive", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "MaxDepth", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "SearchText", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "TemplateZid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "description": "[Enum_name, Enum_updated_at, Enum_created_at]", "schema": { "$ref": "#/components/schemas/ListSpaceSortBy" } }, { "name": "SortOrder", "in": "query", "description": "[Enum_asc, Enum_desc]", "schema": { "$ref": "#/components/schemas/ListSpaceSortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSpaceResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://space:read" ] } ] } }, "/v1/system/health": { "get": { "tags": [ "System" ], "summary": "System_Health_Summary", "description": "System_Health_Description", "parameters": [ { "name": "request", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/HealthRequest" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://system:read" ] } ] } }, "/v1/system/get-api-version": { "get": { "tags": [ "System" ], "summary": "System_GetApiVersion_Summary", "description": "System_GetApiVersion_Description", "parameters": [ { "name": "request", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/GetApiVersionRequest" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetApiVersionResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://system:read" ] } ] } }, "/v1/system/get-zentity-type": { "get": { "tags": [ "System" ], "summary": "System_GetZentityType_Summary", "description": "System_GetZentityType_Description", "parameters": [ { "name": "Zid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetZentityTypeResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://system:read" ] } ] } }, "/v1/template/get": { "get": { "tags": [ "Template" ], "summary": "Template_GetTemplates_Summary", "description": "Template_GetTemplates_Description", "parameters": [ { "name": "TemplateZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "TemplateNames", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTemplatesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://template:read" ] } ] } }, "/v1/template/create": { "post": { "tags": [ "Template" ], "summary": "Template_CreateTemplate_Summary", "description": "Template_CreateTemplate_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://template:create" ] } ] } }, "/v1/template/generate-draft": { "post": { "tags": [ "Template" ], "summary": "Template_GenerateTemplateDraft_Summary", "description": "Template_GenerateTemplateDraft_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateTemplateDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenerateTemplateDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenerateTemplateDraftRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateTemplateDraftResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://template:create" ] } ] } }, "/v1/template/examples": { "get": { "tags": [ "Template" ], "summary": "Template_GetTemplateExamples_Summary", "description": "Template_GetTemplateExamples_Description", "parameters": [ { "name": "TemplateZid", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTemplateExamplesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://template:read" ] } ] } }, "/v1/template/examples/regenerate": { "post": { "tags": [ "Template" ], "summary": "Template_RegenerateTemplateExamples_Summary", "description": "Template_RegenerateTemplateExamples_Description", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegenerateTemplateExamplesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegenerateTemplateExamplesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegenerateTemplateExamplesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegenerateTemplateExamplesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://template:update" ] } ] } }, "/v1/user/get": { "get": { "tags": [ "User" ], "summary": "User_GetUserDetails_Summary", "description": "User_GetUserDetails_Description", "parameters": [ { "name": "UserZids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "Username", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserDetailsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "role://user", "scope://user:read" ] } ] } } }, "components": { "schemas": { "AccountKind": { "type": "string", "description": "[Unspecified, Human, Bot]" }, "AddOrganizationMembershipRequest": { "type": "object", "properties": { "memberships": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationMembershipItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "AddOrganizationMembershipResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "AddressItem": { "type": "object", "properties": { "street1": { "type": "string", "description": "", "nullable": true }, "street2": { "type": "string", "description": "", "nullable": true }, "city": { "type": "string", "description": "", "nullable": true }, "state": { "type": "string", "description": "", "nullable": true }, "zip": { "type": "string", "description": "", "nullable": true }, "country_code": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "AppItem": { "type": "object", "properties": { "app_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" }, "status": { "$ref": "#/components/schemas/AppItem_EntityStatus" }, "description": { "type": "string", "description": "", "nullable": true }, "allowed_scopes": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "organization_zid": { "type": "string", "description": "", "nullable": true }, "links": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "post_logout_redirect_uris": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "allowed_domains": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "require_client_secret": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "AppItem_EntityStatus": { "type": "string", "description": "[Enum_unspecified, Enum_draft, Enum_in_review, Enum_active, Enum_deleted, Enum_deactivated, Enum_initializing, Enum_rejected, Enum_approved]" }, "AppProposalItem": { "type": "object", "properties": { "proposal_zid": { "type": "string", "description": "", "nullable": true }, "app_zid": { "type": "string", "description": "", "nullable": true }, "organization_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" }, "status": { "$ref": "#/components/schemas/AppProposalItem_EntityStatus" }, "description": { "type": "string", "description": "", "nullable": true }, "permissions": { "type": "integer", "description": "", "format": "int64", "nullable": true }, "links": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "allowed_scopes": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "post_logout_redirect_uris": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "allowed_domains": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "require_client_secret": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "AppProposalItem_EntityStatus": { "type": "string", "description": "[Enum_unspecified, Enum_draft, Enum_in_review, Enum_active, Enum_deleted, Enum_deactivated, Enum_initializing, Enum_rejected, Enum_approved]" }, "ApplyEditRequestModel": { "type": "object", "properties": { "content_zid": { "type": "string", "description": "", "nullable": true }, "base_version": { "type": "integer", "description": "", "format": "int64" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/EditOperationModel" }, "description": "", "nullable": true } }, "additionalProperties": false }, "ApplyEditResponseModel": { "type": "object", "properties": { "success": { "type": "boolean", "description": "" }, "error_message": { "type": "string", "description": "", "nullable": true }, "content": { "type": "string", "description": "", "nullable": true }, "version": { "type": "integer", "description": "", "format": "int64" } }, "additionalProperties": false }, "AssetItem": { "type": "object", "properties": { "asset_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "size": { "type": "integer", "description": "", "format": "int64" }, "created_at": { "type": "string", "description": "", "nullable": true }, "updated_at": { "type": "string", "description": "", "nullable": true }, "mime_type": { "type": "string", "description": "", "nullable": true }, "owner_zid": { "type": "string", "description": "", "nullable": true }, "state": { "type": "string", "description": "", "nullable": true }, "content_type_category": { "type": "string", "description": "", "nullable": true }, "reference_count": { "type": "integer", "description": "", "format": "int32" } }, "additionalProperties": false }, "BotCredentialItem": { "type": "object", "properties": { "credential_id": { "type": "string", "description": "", "nullable": true }, "display_name": { "type": "string", "description": "", "nullable": true }, "secret_prefix": { "type": "string", "description": "", "nullable": true }, "allowed_scopes": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" }, "last_used_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "expires_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "revoked_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "replacement_credential_id": { "type": "string", "description": "", "nullable": true }, "created_by_user_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "BotDetailsItem": { "type": "object", "properties": { "bot_user_zid": { "type": "string", "description": "", "nullable": true }, "username": { "type": "string", "description": "", "nullable": true }, "email": { "type": "string", "description": "", "nullable": true }, "email_confirmed": { "type": "boolean", "description": "" }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" }, "account_kind": { "$ref": "#/components/schemas/AccountKind" }, "display_name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "avatar_url": { "type": "string", "description": "", "nullable": true }, "owner_type": { "$ref": "#/components/schemas/BotOwnerType" }, "owner_user_zid": { "type": "string", "description": "", "nullable": true }, "owner_organization_zid": { "type": "string", "description": "", "nullable": true }, "created_by_user_zid": { "type": "string", "description": "", "nullable": true }, "system_managed": { "type": "boolean", "description": "" }, "is_mentionable": { "type": "boolean", "description": "" }, "is_enabled": { "type": "boolean", "description": "" }, "allowed_scopes": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "roles": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "credentials": { "type": "array", "items": { "$ref": "#/components/schemas/BotCredentialItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "BotOwnerType": { "type": "string", "description": "[Unspecified, Personal, Organization, System]" }, "CollaborationParticipantDto": { "type": "object", "properties": { "user_zid": { "type": "string", "description": "", "nullable": true }, "client_id": { "type": "string", "description": "", "nullable": true }, "display_name": { "type": "string", "description": "", "nullable": true }, "color": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CollectionDocumentItem": { "type": "object", "properties": { "document_zid": { "type": "string", "description": "", "nullable": true }, "owner_user_zid": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" }, "payload": { "type": "object", "description": "" }, "comment_metadata": { "description": "", "nullable": true } }, "additionalProperties": false }, "CommentItem": { "type": "object", "properties": { "comment_zid": { "type": "string", "description": "", "nullable": true }, "thread_zid": { "type": "string", "description": "", "nullable": true }, "author_user_zid": { "type": "string", "description": "", "nullable": true }, "body": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" }, "reactions": { "type": "array", "items": { "$ref": "#/components/schemas/CommentReactionSummary" }, "description": "", "nullable": true } }, "additionalProperties": false }, "CommentReactionSummary": { "type": "object", "properties": { "emoji": { "type": "string", "description": "", "nullable": true }, "count": { "type": "integer", "description": "", "format": "int32" }, "reacted_by_current_user": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "CommentThreadItem": { "type": "object", "properties": { "thread_zid": { "type": "string", "description": "", "nullable": true }, "content_zid": { "type": "string", "description": "", "nullable": true }, "document_zid": { "type": "string", "description": "", "nullable": true }, "status": { "$ref": "#/components/schemas/CommentThreadStatus" }, "created_by_user_zid": { "type": "string", "description": "", "nullable": true }, "resolved_by_user_zid": { "type": "string", "description": "", "nullable": true }, "resolved_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" }, "comment_count": { "type": "integer", "description": "", "format": "int32" } }, "additionalProperties": false }, "CommentThreadStatus": { "type": "string", "description": "[Unspecified, Open, Resolved]" }, "CompatibleLayoutItem": { "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/LayoutItem" }, "compatibility_score": { "type": "number", "description": "", "format": "float" }, "compatibility_label": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "ConfirmUploadRequest": { "type": "object", "properties": { "asset_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "ConfirmUploadResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "metadata": { "$ref": "#/components/schemas/AssetItem" }, "error_message": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "ContentKind": { "type": "string", "description": "[Enum_unspecified, Enum_document, Enum_collection, Enum_file]" }, "ContentMetadataItem": { "type": "object", "properties": { "content_zid": { "type": "string", "description": "", "nullable": true }, "space_zid": { "type": "string", "description": "", "nullable": true }, "template_zid": { "type": "string", "description": "", "nullable": true }, "owner_user_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "kind": { "$ref": "#/components/schemas/ContentKind" }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" }, "saved_version": { "type": "integer", "description": "", "format": "int32" }, "current_version": { "type": "integer", "description": "", "format": "int32" }, "edit_version": { "type": "integer", "description": "", "format": "int64" }, "has_draft": { "type": "boolean", "description": "" }, "has_saved": { "type": "boolean", "description": "" }, "draft_record_count": { "type": "integer", "description": "", "format": "int32" }, "saved_record_count": { "type": "integer", "description": "", "format": "int32" }, "draft_updated_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "draft_expires_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "saved_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "saved_from_edit_version": { "type": "integer", "description": "", "format": "int64" }, "user_tags": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, "additionalProperties": false }, "ContentValidationError": { "type": "object", "properties": { "field": { "type": "string", "description": "", "nullable": true }, "message": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateAppProposalRequest": { "type": "object", "properties": { "app_zid": { "type": "string", "description": "", "nullable": true }, "organization_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "allowed_scopes": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "links": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "post_logout_redirect_uris": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "allowed_domains": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "require_client_secret": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "CreateAppProposalResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "proposal_zid": { "type": "string", "description": "", "nullable": true }, "app_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateBotCredentialRequest": { "type": "object", "properties": { "bot_user_zid": { "type": "string", "description": "", "nullable": true }, "display_name": { "type": "string", "description": "", "nullable": true }, "allowed_scopes": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "expires_at": { "type": "string", "description": "", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CreateBotCredentialResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "credential": { "$ref": "#/components/schemas/BotCredentialItem" }, "secret": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateBotRequest": { "type": "object", "properties": { "username": { "type": "string", "description": "", "nullable": true }, "email": { "type": "string", "description": "", "nullable": true }, "display_name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "avatar_url": { "type": "string", "description": "", "nullable": true }, "owner_type": { "$ref": "#/components/schemas/BotOwnerType" }, "owner_user_zid": { "type": "string", "description": "", "nullable": true }, "owner_organization_zid": { "type": "string", "description": "", "nullable": true }, "system_managed": { "type": "boolean", "description": "" }, "is_mentionable": { "type": "boolean", "description": "" }, "allowed_scopes": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "roles": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, "additionalProperties": false }, "CreateBotResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "bot": { "$ref": "#/components/schemas/BotDetailsItem" } }, "additionalProperties": false }, "CreateCollectionRequest": { "type": "object", "properties": { "space_zid": { "type": "string", "description": "", "nullable": true }, "template_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateCollectionResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "content_zid": { "type": "string", "description": "", "nullable": true }, "metadata": { "$ref": "#/components/schemas/ContentMetadataItem" } }, "additionalProperties": false }, "CreateCommentRequest": { "type": "object", "properties": { "content_zid": { "type": "string", "description": "", "nullable": true }, "document_zid": { "type": "string", "description": "", "nullable": true }, "thread_zid": { "type": "string", "description": "", "nullable": true }, "body": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateCommentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "thread": { "$ref": "#/components/schemas/CommentThreadItem" }, "comment": { "$ref": "#/components/schemas/CommentItem" }, "thread_created": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "CreateDocumentRequest": { "type": "object", "properties": { "space_zid": { "type": "string", "description": "", "nullable": true }, "template_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "payload": { "description": "", "nullable": true }, "comment_metadata": { "description": "", "nullable": true }, "is_draft": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "CreateDocumentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "content_zid": { "type": "string", "description": "", "nullable": true }, "metadata": { "$ref": "#/components/schemas/ContentMetadataItem" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ContentValidationError" }, "description": "", "nullable": true } }, "additionalProperties": false }, "CreateDriveRequest": { "type": "object", "properties": { "owner_entity_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "quota_limit_bytes": { "type": "integer", "description": "", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CreateDriveResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "drive_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateLayoutRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "layout_definition": { "type": "string", "description": "", "nullable": true }, "org_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateLayoutResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "layout_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateOrganizationRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "address": { "$ref": "#/components/schemas/AddressItem" }, "phone": { "type": "string", "description": "", "nullable": true }, "email": { "type": "string", "description": "", "nullable": true }, "website": { "type": "string", "description": "", "nullable": true }, "country_code": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateOrganizationResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "organization_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateSpaceRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "template_zids": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "parent_space_zid": { "type": "string", "description": "", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, "additionalProperties": false }, "CreateSpaceResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "space_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateTemplateRequest": { "type": "object", "properties": { "template_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "ztl_definition": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "CreateTemplateResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "template_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "DeleteAppProposalResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "DeleteAppResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "DeleteAssetResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "DeleteBotResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "DeleteCollectionDocumentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "metadata": { "$ref": "#/components/schemas/ContentMetadataItem" } }, "additionalProperties": false }, "DeleteCommentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "comment_zid": { "type": "string", "description": "", "nullable": true }, "thread_zid": { "type": "string", "description": "", "nullable": true }, "thread_deleted": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "DeleteContentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "DeleteDriveResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "DeleteLayoutResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "DeleteOrganizationMembershipResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "DeleteOrganizationResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "DeleteSpaceResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "DriveItem": { "type": "object", "properties": { "drive_zid": { "type": "string", "description": "", "nullable": true }, "owner_entity_zid": { "type": "string", "description": "", "nullable": true }, "root_space_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "created_by_user_zid": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" }, "quota_limit_bytes": { "type": "integer", "description": "", "format": "int64", "nullable": true }, "quota_used_bytes": { "type": "integer", "description": "", "format": "int64", "nullable": true } }, "additionalProperties": false }, "DriveListMode": { "type": "string", "description": "[Enum_visible, Enum_admin]" }, "EditOperationModel": { "type": "object", "properties": { "type": { "type": "string", "description": "", "nullable": true }, "offset": { "type": "integer", "description": "", "format": "int32" }, "text": { "type": "string", "description": "", "nullable": true }, "length": { "type": "integer", "description": "", "format": "int32", "nullable": true } }, "additionalProperties": false }, "EntitlementItem": { "type": "object", "properties": { "entitlement_zid": { "type": "string", "description": "", "nullable": true }, "product_zid": { "type": "string", "description": "", "nullable": true }, "owner_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "features": { "type": "string", "description": "", "nullable": true }, "billing_frequency": { "$ref": "#/components/schemas/Frequency" }, "subscription_cost": { "type": "integer", "description": "", "format": "int32" }, "included_api_calls": { "type": "integer", "description": "", "format": "int32" }, "overage_cost_per_1k_calls": { "type": "integer", "description": "", "format": "int32" }, "max_api_calls": { "type": "integer", "description": "", "format": "int32" }, "included_tokens": { "type": "integer", "description": "", "format": "int64" }, "max_tokens": { "type": "integer", "description": "", "format": "int64" }, "support_level": { "$ref": "#/components/schemas/SupportLevel" }, "minute_rate_limit": { "type": "integer", "description": "", "format": "int32" }, "hour_rate_limit": { "type": "integer", "description": "", "format": "int32" }, "day_rate_limit": { "type": "integer", "description": "", "format": "int32" }, "status": { "$ref": "#/components/schemas/EntitlementStatus" } }, "additionalProperties": false }, "EntitlementStatus": { "type": "string", "description": "[Unspecified, Initializing, Active, Suspended, Deactivated]" }, "EntitySummary": { "type": "object", "properties": { "zid": { "type": "string", "description": "", "nullable": true }, "entity_type": { "$ref": "#/components/schemas/EntityTypeFilter" }, "display_name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "icon_url": { "type": "string", "description": "", "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "", "nullable": true } }, "additionalProperties": false }, "EntityType": { "type": "string", "description": "[Enum_unknown, Enum_user, Enum_app, Enum_organization, Enum_entitlement]" }, "EntityTypeFilter": { "type": "string", "description": "[Enum_unspecified, Enum_user, Enum_organization, Enum_space, Enum_content, Enum_app, Enum_template, Enum_product, Enum_product_group, Enum_entitlement]" }, "Error": { "type": "object", "properties": { "code": { "type": "string", "description": "", "nullable": true }, "field": { "type": "string", "description": "", "nullable": true }, "message": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "Frequency": { "type": "string", "description": "[Unspecified, OneTime, Daily, Weekly, Monthly, Quarterly, Annually]" }, "GenerateAppSecretRequest": { "type": "object", "properties": { "app_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "GenerateAppSecretResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "secret": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "GenerateTemplateDraftRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "existing_ztl_definition": { "type": "string", "description": "", "nullable": true }, "require_collection_compatible": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "GenerateTemplateDraftResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "ztl_definition": { "type": "string", "description": "", "nullable": true }, "is_collection_compatible": { "type": "boolean", "description": "" }, "compatibility_reason": { "type": "string", "description": "", "nullable": true }, "validation_issues": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateDraftIssue" }, "description": "", "nullable": true }, "model_used": { "type": "string", "description": "", "nullable": true }, "tokens_used": { "type": "integer", "description": "", "format": "int32" }, "cached": { "type": "boolean", "description": "" }, "error_message": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "GetApiVersionRequest": { "type": "object", "additionalProperties": false }, "GetApiVersionResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "version": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "GetAppProposalsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "proposals": { "type": "array", "items": { "$ref": "#/components/schemas/AppProposalItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetAppsRequest_AppFilter": { "type": "string", "description": "[Enum_unspecified, Enum_all, Enum_my_organization_apps]" }, "GetAppsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "apps": { "type": "array", "items": { "$ref": "#/components/schemas/AppItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetAssetMetadataResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "metadata": { "$ref": "#/components/schemas/AssetItem" } }, "additionalProperties": false }, "GetBotCredentialsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "credentials": { "type": "array", "items": { "$ref": "#/components/schemas/BotCredentialItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetBotsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "bots": { "type": "array", "items": { "$ref": "#/components/schemas/BotDetailsItem" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int64" }, "limit": { "type": "integer", "description": "", "format": "int32" }, "offset": { "type": "integer", "description": "", "format": "int32" } }, "additionalProperties": false }, "GetCollectionDocumentsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "metadata": { "$ref": "#/components/schemas/ContentMetadataItem" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionDocumentItem" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int64" }, "error_message": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "GetCommentThreadsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "threads": { "type": "array", "items": { "$ref": "#/components/schemas/CommentThreadItem" }, "description": "", "nullable": true }, "next_cursor": { "type": "string", "description": "", "nullable": true }, "has_more": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "GetCommentsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/CommentItem" }, "description": "", "nullable": true }, "next_cursor": { "type": "string", "description": "", "nullable": true }, "has_more": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "GetCompatibleLayoutsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "compatible_layouts": { "type": "array", "items": { "$ref": "#/components/schemas/CompatibleLayoutItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetContentLayoutResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "layout_zid": { "type": "string", "description": "", "nullable": true }, "resolved_layout": { "$ref": "#/components/schemas/LayoutItem" }, "resolution_source": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "GetContentMetadataResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContentMetadataItem" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int64" } }, "additionalProperties": false }, "GetDocumentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "metadata": { "$ref": "#/components/schemas/ContentMetadataItem" }, "payload": { "description": "", "nullable": true }, "comment_metadata": { "description": "", "nullable": true } }, "additionalProperties": false }, "GetDriveResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "drive": { "$ref": "#/components/schemas/DriveItem" } }, "additionalProperties": false }, "GetEntitlementsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetEntitySummaryResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySummary" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int32" }, "error_message": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "GetInvoicesResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetLayoutDslMetadataResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "version": { "type": "integer", "description": "", "format": "int32" }, "schema_version": { "type": "string", "description": "", "nullable": true }, "elements": { "type": "array", "items": { "$ref": "#/components/schemas/LayoutElementMetadata" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetLayoutResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "layout": { "$ref": "#/components/schemas/LayoutItem" } }, "additionalProperties": false }, "GetNotificationPreferencesResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "preferences": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationPreferenceItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetNotificationsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationItem" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int64" }, "limit": { "type": "integer", "description": "", "format": "int32" }, "offset": { "type": "integer", "description": "", "format": "int32" } }, "additionalProperties": false }, "GetOrganizationMembershipsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "memberships": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationMembershipItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetOrganizationsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationItem" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int64" }, "limit": { "type": "integer", "description": "", "format": "int32" }, "offset": { "type": "integer", "description": "", "format": "int32" } }, "additionalProperties": false }, "GetPermissionsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "effective_permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDto" }, "description": "", "nullable": true }, "immediate_permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDto" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetProductGroupsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "product_groups": { "type": "array", "items": { "$ref": "#/components/schemas/ProductGroupItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetProductsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetRecentlyAccessedResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/RecentEntitySummary" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int64" }, "error_message": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "GetScopesResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "scopes": { "type": "array", "items": { "$ref": "#/components/schemas/ScopeItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetSpacesResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "spaces": { "type": "array", "items": { "$ref": "#/components/schemas/SpaceItem" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int64" }, "limit": { "type": "integer", "description": "", "format": "int32" }, "offset": { "type": "integer", "description": "", "format": "int32" } }, "additionalProperties": false }, "GetTemplateExamplesResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "template_zid": { "type": "string", "description": "", "nullable": true }, "generation_status": { "type": "string", "description": "", "nullable": true }, "generation_error": { "type": "string", "description": "", "nullable": true }, "examples": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateExamplePayloadItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetTemplatesResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "templates": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateItem" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int64" }, "limit": { "type": "integer", "description": "", "format": "int32" }, "offset": { "type": "integer", "description": "", "format": "int32" } }, "additionalProperties": false }, "GetUnreadCountResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "unread_count": { "type": "integer", "description": "", "format": "int64" } }, "additionalProperties": false }, "GetUsageResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "usage_slots": { "type": "array", "items": { "$ref": "#/components/schemas/UsageItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "GetUserDetailsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserDetailsItem" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int64" }, "limit": { "type": "integer", "description": "", "format": "int32" }, "offset": { "type": "integer", "description": "", "format": "int32" } }, "additionalProperties": false }, "GetUserTaggedContentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "tagged_content": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaggedContentItem" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int64" } }, "additionalProperties": false }, "GetUserTaggedSpacesResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "tagged_spaces": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaggedSpaceItem" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int64" } }, "additionalProperties": false }, "GetZentityTypeResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "zentityType": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "HealthRequest": { "type": "object", "additionalProperties": false }, "HealthResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "InsertCollectionDocumentRequest": { "type": "object", "properties": { "content_zid": { "type": "string", "description": "", "nullable": true }, "payload": { "type": "object", "description": "" }, "comment_metadata": { "description": "", "nullable": true } }, "additionalProperties": false }, "InsertCollectionDocumentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "document_zid": { "type": "string", "description": "", "nullable": true }, "metadata": { "$ref": "#/components/schemas/ContentMetadataItem" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ContentValidationError" }, "description": "", "nullable": true } }, "additionalProperties": false }, "InvoiceItem": { "type": "object", "properties": { "invoice_zid": { "type": "string", "description": "", "nullable": true }, "entitlement_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "start_time": { "type": "string", "description": "", "format": "date-time" }, "end_time": { "type": "string", "description": "", "format": "date-time" }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "due_time": { "type": "string", "description": "", "format": "date-time" }, "total_cost": { "type": "integer", "description": "", "format": "int32" }, "download_url": { "type": "string", "description": "", "nullable": true }, "status": { "$ref": "#/components/schemas/InvoiceStatus" }, "line_items": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceItem_LineItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "InvoiceItem_LineItem": { "type": "object", "properties": { "invoice_line_item_zid": { "type": "string", "description": "", "nullable": true }, "quantity": { "type": "integer", "description": "", "format": "int32" }, "cost": { "type": "integer", "description": "", "format": "int32" }, "charge_code": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "InvoiceStatus": { "type": "string", "description": "[Unspecified, Draft, Unpaid, Paid, Overdue, Delinquent, Cancelled, WrittenOff]" }, "JoinContentCollaborationResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "" }, "session_id": { "type": "string", "description": "", "nullable": true }, "client_id": { "type": "string", "description": "", "nullable": true }, "assigned_color": { "type": "string", "description": "", "nullable": true }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/CollaborationParticipantDto" }, "description": "", "nullable": true }, "error": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "LayoutAiMetadata": { "type": "object", "properties": { "prompt_name": { "type": "string", "description": "", "nullable": true }, "prompt_description": { "type": "string", "description": "", "nullable": true }, "example_json": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "LayoutBindingMetadata": { "type": "object", "properties": { "name": { "type": "string", "description": "", "nullable": true }, "property_name": { "type": "string", "description": "", "nullable": true }, "binding_kind": { "type": "string", "description": "", "nullable": true }, "required": { "type": "boolean", "description": "" }, "is_collection": { "type": "boolean", "description": "" }, "expected_type_property_name": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "LayoutBuilderMetadata": { "type": "object", "properties": { "label": { "type": "string", "description": "", "nullable": true }, "category": { "type": "string", "description": "", "nullable": true }, "builder_key": { "type": "string", "description": "", "nullable": true }, "default_node_json": { "type": "string", "description": "", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "icon_key": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "LayoutChildSlotMetadata": { "type": "object", "properties": { "name": { "type": "string", "description": "", "nullable": true }, "display_name": { "type": "string", "description": "", "nullable": true }, "min_children": { "type": "integer", "description": "", "format": "int32" }, "max_children": { "type": "integer", "description": "", "format": "int32" }, "allowed_kinds": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, "additionalProperties": false }, "LayoutElementDefaultsMetadata": { "type": "object", "properties": { "node_json": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "LayoutElementMetadata": { "type": "object", "properties": { "type_name": { "type": "string", "description": "", "nullable": true }, "kind": { "type": "string", "description": "", "nullable": true }, "category": { "type": "string", "description": "", "nullable": true }, "display_name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "renderer_key": { "type": "string", "description": "", "nullable": true }, "builder_key": { "type": "string", "description": "", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/LayoutPropertyMetadata" }, "description": "", "nullable": true }, "bindings": { "type": "array", "items": { "$ref": "#/components/schemas/LayoutBindingMetadata" }, "description": "", "nullable": true }, "child_slots": { "type": "array", "items": { "$ref": "#/components/schemas/LayoutChildSlotMetadata" }, "description": "", "nullable": true }, "defaults": { "$ref": "#/components/schemas/LayoutElementDefaultsMetadata" }, "builder": { "$ref": "#/components/schemas/LayoutBuilderMetadata" }, "ai": { "$ref": "#/components/schemas/LayoutAiMetadata" } }, "additionalProperties": false }, "LayoutItem": { "type": "object", "properties": { "layout_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "layout_definition": { "type": "string", "description": "", "nullable": true }, "created_by_zid": { "type": "string", "description": "", "nullable": true }, "org_zid": { "type": "string", "description": "", "nullable": true }, "is_system_generated": { "type": "boolean", "description": "" }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" } }, "additionalProperties": false }, "LayoutPropertyMetadata": { "type": "object", "properties": { "name": { "type": "string", "description": "", "nullable": true }, "value_type": { "type": "string", "description": "", "nullable": true }, "display_name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "is_required": { "type": "boolean", "description": "" }, "supports_dynamic_values": { "type": "boolean", "description": "" }, "default_value_json": { "type": "string", "description": "", "nullable": true }, "allowed_values": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, "additionalProperties": false }, "LeaveContentCollaborationResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "" }, "session_stopped": { "type": "boolean", "description": "" }, "error": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "LinkAssetRequest": { "type": "object", "properties": { "asset_zid": { "type": "string", "description": "", "nullable": true }, "entity_zid": { "type": "string", "description": "", "nullable": true }, "link_type": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "LinkAssetResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "ListAssetsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/AssetItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "ListDrivesResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "drives": { "type": "array", "items": { "$ref": "#/components/schemas/DriveItem" }, "description": "", "nullable": true }, "total_count": { "type": "integer", "description": "", "format": "int32" }, "limit": { "type": "integer", "description": "", "format": "int32" }, "offset": { "type": "integer", "description": "", "format": "int32" } }, "additionalProperties": false }, "ListLayoutsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "layouts": { "type": "array", "items": { "$ref": "#/components/schemas/LayoutItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "ListSpaceItem": { "type": "object", "properties": { "item_type": { "$ref": "#/components/schemas/ListSpaceItem_ItemType" }, "zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "parent_space_zid": { "type": "string", "description": "", "nullable": true }, "owner_user_zid": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" }, "template_zid": { "type": "string", "description": "", "nullable": true }, "has_saved": { "type": "boolean", "description": "" }, "has_draft": { "type": "boolean", "description": "" }, "draft_updated_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "version": { "type": "integer", "description": "", "format": "int32" }, "is_valid": { "type": "boolean", "description": "" }, "template_zids": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "user_tags": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, "additionalProperties": false }, "ListSpaceItem_ItemType": { "type": "string", "description": "[Enum_space, Enum_content]" }, "ListSpaceResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "total_count": { "type": "integer", "description": "", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListSpaceItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "ListSpaceSortBy": { "type": "string", "description": "[Enum_name, Enum_updated_at, Enum_created_at]" }, "ListSpaceSortOrder": { "type": "string", "description": "[Enum_asc, Enum_desc]" }, "MarkNotificationsRequest": { "type": "object", "properties": { "notification_zids": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "state": { "$ref": "#/components/schemas/NotificationState" } }, "additionalProperties": false }, "MarkNotificationsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "updated_count": { "type": "integer", "description": "", "format": "int32" } }, "additionalProperties": false }, "NotificationCategory": { "type": "string", "description": "[Unspecified, ContentSaved, DocumentShared, SpaceShared, PermissionChanged, CollaboratorJoined, WeeklyDigest, CommentMention]" }, "NotificationChannel": { "type": "string", "description": "[Unspecified, InApp, Email]" }, "NotificationItem": { "type": "object", "properties": { "notification_zid": { "type": "string", "description": "", "nullable": true }, "category": { "$ref": "#/components/schemas/NotificationCategory" }, "title": { "type": "string", "description": "", "nullable": true }, "body": { "type": "string", "description": "", "nullable": true }, "source_user_zid": { "type": "string", "description": "", "nullable": true }, "target_entity_zid": { "type": "string", "description": "", "nullable": true }, "space_zid": { "type": "string", "description": "", "nullable": true }, "comment_thread_zid": { "type": "string", "description": "", "nullable": true }, "comment_row_zid": { "type": "string", "description": "", "nullable": true }, "state": { "$ref": "#/components/schemas/NotificationState" }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "read_at": { "type": "string", "description": "", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "NotificationPreferenceItem": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/NotificationCategory" }, "channel": { "$ref": "#/components/schemas/NotificationChannel" }, "enabled": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "NotificationState": { "type": "string", "description": "[Unspecified, Unread, Read, Deleted]" }, "OrganizationItem": { "type": "object", "properties": { "organization_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "address": { "$ref": "#/components/schemas/AddressItem" }, "phone": { "type": "string", "description": "", "nullable": true }, "email": { "type": "string", "description": "", "nullable": true }, "website": { "type": "string", "description": "", "nullable": true }, "verified_details": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" } }, "additionalProperties": false }, "OrganizationMembershipItem": { "type": "object", "properties": { "membership_zid": { "type": "string", "description": "", "nullable": true }, "organization_zid": { "type": "string", "description": "", "nullable": true }, "user_zid": { "type": "string", "description": "", "nullable": true }, "role": { "$ref": "#/components/schemas/OrganizationMembershipItem_Role" } }, "additionalProperties": false }, "OrganizationMembershipItem_Role": { "type": "string", "description": "[Enum_unspecified, Enum_admin, Enum_moderator, Enum_user]" }, "PermissionDto": { "type": "object", "properties": { "space_zid": { "type": "string", "description": "", "nullable": true }, "entity_zid": { "type": "string", "description": "", "nullable": true }, "type": { "$ref": "#/components/schemas/EntityType" }, "space_create": { "$ref": "#/components/schemas/PermissionDto_PermissionAccess" }, "space_read": { "$ref": "#/components/schemas/PermissionDto_PermissionAccess" }, "space_update": { "$ref": "#/components/schemas/PermissionDto_PermissionAccess" }, "space_delete": { "$ref": "#/components/schemas/PermissionDto_PermissionAccess" }, "content_create": { "$ref": "#/components/schemas/PermissionDto_PermissionAccess" }, "content_read": { "$ref": "#/components/schemas/PermissionDto_PermissionAccess" }, "content_update": { "$ref": "#/components/schemas/PermissionDto_PermissionAccess" }, "content_delete": { "$ref": "#/components/schemas/PermissionDto_PermissionAccess" }, "space_list": { "$ref": "#/components/schemas/PermissionDto_PermissionAccess" }, "space_permission_get": { "$ref": "#/components/schemas/PermissionDto_PermissionAccess" }, "space_permission_set": { "$ref": "#/components/schemas/PermissionDto_PermissionAccess" } }, "additionalProperties": false }, "PermissionDto_PermissionAccess": { "type": "string", "description": "[Enum_unspecified, Enum_allow, Enum_deny, Enum_inherit]" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "description": "", "nullable": true }, "title": { "type": "string", "description": "", "nullable": true }, "status": { "type": "integer", "description": "", "format": "int32", "nullable": true }, "detail": { "type": "string", "description": "", "nullable": true }, "instance": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": { } }, "ProductGroupItem": { "type": "object", "properties": { "product_group_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "ProductItem": { "type": "object", "properties": { "product_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "features": { "type": "string", "description": "", "nullable": true }, "required_activation_role": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "billing_frequency": { "$ref": "#/components/schemas/Frequency" }, "subscription_cost": { "type": "integer", "description": "", "format": "int32" }, "included_api_calls": { "type": "integer", "description": "", "format": "int32" }, "overage_cost_per_1k_calls": { "type": "integer", "description": "", "format": "int32" }, "max_api_calls": { "type": "integer", "description": "", "format": "int32" }, "support_level": { "$ref": "#/components/schemas/SupportLevel" }, "minute_rate_limit": { "type": "integer", "description": "", "format": "int32" }, "hour_rate_limit": { "type": "integer", "description": "", "format": "int32" }, "day_rate_limit": { "type": "integer", "description": "", "format": "int32" }, "product_group_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "PromoteAppProposalRequest": { "type": "object", "properties": { "proposal_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "PromoteAppProposalResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "PurchaseProductRequest": { "type": "object", "properties": { "product_zid": { "type": "string", "description": "", "nullable": true }, "owner_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "PurchaseProductResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "entitlement_zid": { "type": "string", "description": "", "nullable": true }, "payment_link": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "RecentEntitySummary": { "type": "object", "properties": { "zid": { "type": "string", "description": "", "nullable": true }, "entity_type": { "$ref": "#/components/schemas/EntityTypeFilter" }, "display_name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "icon_url": { "type": "string", "description": "", "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "", "nullable": true }, "last_accessed_at": { "type": "string", "description": "", "format": "date-time" }, "access_count": { "type": "integer", "description": "", "format": "int32" } }, "additionalProperties": false }, "RegenerateLayoutsRequest": { "type": "object", "properties": { "template_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "RegenerateLayoutsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "RegenerateTemplateExamplesRequest": { "type": "object", "properties": { "template_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "RegenerateTemplateExamplesResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "template_zid": { "type": "string", "description": "", "nullable": true }, "generation_status": { "type": "string", "description": "", "nullable": true }, "generation_error": { "type": "string", "description": "", "nullable": true }, "examples": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateExamplePayloadItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "ReopenCommentThreadRequest": { "type": "object", "properties": { "thread_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "ReopenCommentThreadResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "thread": { "$ref": "#/components/schemas/CommentThreadItem" } }, "additionalProperties": false }, "RequestUploadRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "mime_type": { "type": "string", "description": "", "nullable": true }, "size": { "type": "integer", "description": "", "format": "int64" }, "content_type_category": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "RequestUploadResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "upload_url": { "type": "string", "description": "", "nullable": true }, "asset_zid": { "type": "string", "description": "", "nullable": true }, "error_message": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "ResetContentLayoutResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "ResolveCommentThreadRequest": { "type": "object", "properties": { "thread_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "ResolveCommentThreadResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "thread": { "$ref": "#/components/schemas/CommentThreadItem" } }, "additionalProperties": false }, "RevokeBotCredentialRequest": { "type": "object", "properties": { "bot_user_zid": { "type": "string", "description": "", "nullable": true }, "credential_id": { "type": "string", "description": "", "nullable": true }, "replacement_credential_id": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "RevokeBotCredentialResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "credential": { "$ref": "#/components/schemas/BotCredentialItem" } }, "additionalProperties": false }, "SaveContentRequest": { "type": "object", "properties": { "content_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "SaveContentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "version": { "type": "integer", "description": "", "format": "int32" }, "metadata": { "$ref": "#/components/schemas/ContentMetadataItem" }, "validation_errors": { "type": "array", "items": { "$ref": "#/components/schemas/ContentValidationError" }, "description": "", "nullable": true } }, "additionalProperties": false }, "ScopeItem": { "type": "object", "properties": { "name": { "type": "string", "description": "", "nullable": true }, "friendly_name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "sensitivity": { "$ref": "#/components/schemas/ScopeItem_DataSensitivity" }, "power_level": { "$ref": "#/components/schemas/ScopeItem_PowerLevel" } }, "additionalProperties": false }, "ScopeItem_DataSensitivity": { "type": "string", "description": "[Enum_none, Enum_low, Enum_medium, Enum_high, Enum_dynamic]" }, "ScopeItem_PowerLevel": { "type": "string", "description": "[Enum_low, Enum_medium, Enum_high]" }, "SendBotEmailVerificationRequest": { "type": "object", "properties": { "bot_user_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "SendBotEmailVerificationResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "SetBotEnabledRequest": { "type": "object", "properties": { "bot_user_zid": { "type": "string", "description": "", "nullable": true }, "enabled": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "SetBotEnabledResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "bot": { "$ref": "#/components/schemas/BotDetailsItem" } }, "additionalProperties": false }, "SetContentLayoutRequest": { "type": "object", "properties": { "content_zid": { "type": "string", "description": "", "nullable": true }, "layout_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "SetContentLayoutResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "SetContentUserTagRequest": { "type": "object", "properties": { "content_zid": { "type": "string", "description": "", "nullable": true }, "tag": { "type": "string", "description": "", "nullable": true }, "present": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "SetContentUserTagResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "SetNotificationPreferencesRequest": { "type": "object", "properties": { "preferences": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationPreferenceItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "SetNotificationPreferencesResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "preferences": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationPreferenceItem" }, "description": "", "nullable": true } }, "additionalProperties": false }, "SetPermissionsRequest": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDto" }, "description": "", "nullable": true } }, "additionalProperties": false }, "SetPermissionsResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "SetSpaceUserTagRequest": { "type": "object", "properties": { "space_zid": { "type": "string", "description": "", "nullable": true }, "tag": { "type": "string", "description": "", "nullable": true }, "present": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "SetSpaceUserTagResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "SpaceItem": { "type": "object", "properties": { "space_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "template_zids": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "parent_space_zid": { "type": "string", "description": "", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "user_tags": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "creator_user_zid": { "type": "string", "description": "", "nullable": true }, "creator_app_zid": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "updated_at": { "type": "string", "description": "", "format": "date-time" } }, "additionalProperties": false }, "SubmitAppProposalRequest": { "type": "object", "properties": { "proposal_zid": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "SubmitAppProposalResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "state": { "$ref": "#/components/schemas/SubmitAppProposalResponse_SubmissionState" } }, "additionalProperties": false }, "SubmitAppProposalResponse_SubmissionState": { "type": "string", "description": "[Enum_unspecified, Enum_approved, Enum_rejected, Enum_in_review, Enum_promoted]" }, "SupportLevel": { "type": "string", "description": "[Unspecified, Community, ZentrumL1, ZentrumL2, ZentrumL3, Author]" }, "TemplateDraftIssue": { "type": "object", "properties": { "path": { "type": "string", "description": "", "nullable": true }, "message": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "TemplateExamplePayloadItem": { "type": "object", "properties": { "template_zid": { "type": "string", "description": "", "nullable": true }, "example_key": { "type": "string", "description": "", "nullable": true }, "display_name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "payload_json": { "type": "string", "description": "", "nullable": true }, "source": { "type": "string", "description": "", "nullable": true }, "generator_version": { "type": "string", "description": "", "nullable": true }, "model_used": { "type": "string", "description": "", "nullable": true }, "tokens_used": { "type": "integer", "description": "", "format": "int32", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "is_active": { "type": "boolean", "description": "" }, "generation_status": { "type": "string", "description": "", "nullable": true }, "generation_error": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "TemplateItem": { "type": "object", "properties": { "template_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "ztl_definition": { "type": "string", "description": "", "nullable": true }, "is_flat": { "type": "boolean", "description": "" }, "default_layout_zid": { "type": "string", "description": "", "nullable": true }, "layout_generation_status": { "type": "string", "description": "", "nullable": true }, "layout_generation_error": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "ToggleCommentReactionRequest": { "type": "object", "properties": { "comment_zid": { "type": "string", "description": "", "nullable": true }, "emoji": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "ToggleCommentReactionResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "comment": { "$ref": "#/components/schemas/CommentItem" } }, "additionalProperties": false }, "UnlinkAssetResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "UpdateAppProposalRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "links": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "proposal_zid": { "type": "string", "description": "", "nullable": true }, "allowed_scopes": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "post_logout_redirect_uris": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "allowed_domains": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "require_client_secret": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "UpdateAppProposalResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "UpdateBotRequest": { "type": "object", "properties": { "bot_user_zid": { "type": "string", "description": "", "nullable": true }, "username": { "type": "string", "description": "", "nullable": true }, "email": { "type": "string", "description": "", "nullable": true }, "display_name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "avatar_url": { "type": "string", "description": "", "nullable": true }, "is_mentionable": { "type": "boolean", "description": "" }, "allowed_scopes": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "roles": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, "additionalProperties": false }, "UpdateBotResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "bot": { "$ref": "#/components/schemas/BotDetailsItem" } }, "additionalProperties": false }, "UpdateCollectionDocumentRequest": { "type": "object", "properties": { "content_zid": { "type": "string", "description": "", "nullable": true }, "document_zid": { "type": "string", "description": "", "nullable": true }, "payload": { "type": "object", "description": "" }, "comment_metadata": { "description": "", "nullable": true } }, "additionalProperties": false }, "UpdateCollectionDocumentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "metadata": { "$ref": "#/components/schemas/ContentMetadataItem" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ContentValidationError" }, "description": "", "nullable": true } }, "additionalProperties": false }, "UpdateCollectionRequest": { "type": "object", "properties": { "content_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "UpdateCollectionResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "metadata": { "$ref": "#/components/schemas/ContentMetadataItem" } }, "additionalProperties": false }, "UpdateCommentRequest": { "type": "object", "properties": { "comment_zid": { "type": "string", "description": "", "nullable": true }, "body": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "UpdateCommentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "comment": { "$ref": "#/components/schemas/CommentItem" } }, "additionalProperties": false }, "UpdateDocumentRequest": { "type": "object", "properties": { "content_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "payload": { "description": "", "nullable": true }, "comment_metadata": { "description": "", "nullable": true }, "is_draft": { "type": "boolean", "description": "" } }, "additionalProperties": false }, "UpdateDocumentResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "metadata": { "$ref": "#/components/schemas/ContentMetadataItem" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ContentValidationError" }, "description": "", "nullable": true } }, "additionalProperties": false }, "UpdateDriveRequest": { "type": "object", "properties": { "drive_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "quota_limit_bytes": { "type": "integer", "description": "", "format": "int64", "nullable": true } }, "additionalProperties": false }, "UpdateDriveResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "UpdateLayoutRequest": { "type": "object", "properties": { "layout_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "layout_definition": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "UpdateLayoutResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "UpdateOrganizationRequest": { "required": [ "organization_zid" ], "type": "object", "properties": { "organization_zid": { "minLength": 1, "type": "string", "description": "" }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "address": { "$ref": "#/components/schemas/AddressItem" }, "phone": { "type": "string", "description": "", "format": "tel", "nullable": true }, "email": { "type": "string", "description": "", "format": "email", "nullable": true }, "website": { "type": "string", "description": "", "format": "uri", "nullable": true }, "country_code": { "maxLength": 2, "minLength": 2, "type": "string", "description": "", "nullable": true } }, "additionalProperties": false }, "UpdateOrganizationResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "UpdateSpaceRequest": { "type": "object", "properties": { "space_zid": { "type": "string", "description": "", "nullable": true }, "name": { "type": "string", "description": "", "nullable": true }, "description": { "type": "string", "description": "", "nullable": true }, "template_zids": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true }, "parent_space_zid": { "type": "string", "description": "", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, "additionalProperties": false }, "UpdateSpaceResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } }, "additionalProperties": false }, "UsageItem": { "type": "object", "properties": { "app_zid": { "type": "string", "description": "", "nullable": true }, "owner_zid": { "type": "string", "description": "", "nullable": true }, "entitlement_zid": { "type": "string", "description": "", "nullable": true }, "start_time": { "type": "string", "description": "", "format": "date-time" }, "end_time": { "type": "string", "description": "", "format": "date-time" }, "route": { "type": "string", "description": "", "nullable": true }, "count": { "type": "integer", "description": "", "format": "int32" }, "token_count": { "type": "integer", "description": "", "format": "int64" } }, "additionalProperties": false }, "UserDetailsItem": { "type": "object", "properties": { "user_zid": { "type": "string", "description": "", "nullable": true }, "email": { "type": "string", "description": "", "nullable": true }, "username": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" }, "date_of_birth": { "type": "string", "description": "", "format": "date", "nullable": true }, "account_kind": { "$ref": "#/components/schemas/AccountKind" }, "email_confirmed": { "type": "boolean", "description": "" }, "phone_number_confirmed": { "type": "boolean", "description": "" }, "two_factor_enabled": { "type": "boolean", "description": "" }, "lockout_end": { "type": "string", "description": "", "format": "date-time", "nullable": true }, "roles": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, "additionalProperties": false }, "UserTaggedContentItem": { "type": "object", "properties": { "content_zid": { "type": "string", "description": "", "nullable": true }, "tag": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" } }, "additionalProperties": false }, "UserTaggedSpaceItem": { "type": "object", "properties": { "space_zid": { "type": "string", "description": "", "nullable": true }, "tag": { "type": "string", "description": "", "nullable": true }, "created_at": { "type": "string", "description": "", "format": "date-time" } }, "additionalProperties": false } }, "securitySchemes": { "oauth2": { "type": "oauth2" }, "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "Api", "description": "Controller_Api_Description" }, { "name": "App", "description": "Controller_App_Description" }, { "name": "Asset", "description": "" }, { "name": "Bot", "description": "Bot management" }, { "name": "Collection", "description": "Controller_Collection_Description" }, { "name": "Comment", "description": "Controller_Comment_Description" }, { "name": "Content", "description": "Controller_Content_Description" }, { "name": "Document", "description": "Controller_Document_Description" }, { "name": "Drive", "description": "Controller_Drive_Description" }, { "name": "Entity", "description": "Controller_Entity_Description" }, { "name": "Layout", "description": "Controller_Layout_Description" }, { "name": "Notification", "description": "Controller_Notification_Description" }, { "name": "Organization", "description": "Controller_Organization_Description" }, { "name": "Product", "description": "Controller_Product_Description" }, { "name": "Space", "description": "Controller_Space_Description" }, { "name": "System", "description": "Controller_System_Description" }, { "name": "Template", "description": "Controller_Template_Description" }, { "name": "User", "description": "Controller_User_Description" } ] }