Diese Spezifikation bezieht sich auf den AI Connector. Für weitere Details siehe bitte Technische Dokumentation für den AI Connector.
{
"openapi": "3.0.3",
"info": {
"title": "Content Connector OpenAPI definition",
"version": "1.0.0",
"contact": {
"name": "Integrations"
}
},
"servers": [
{
"url": "http://localhost:8075"
}
],
"paths": {
"/web/content-connector/events/{entityType}/deletes": {
"get": {
"tags": [
"public-events"
],
"description": "Endpoint to get all deleted entities references. Context only of the tenant extracted from the security context.",
"operationId": "get-deleted-entities",
"security": [
{
"haiiloToken": []
}
],
"parameters": [
{
"name": "entityType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/entity-type"
}
},
{
"name": "startId",
"in": "query",
"required": false,
"schema": {
"default": 0,
"minimum": 0,
"type": "integer",
"format": "int64"
}
},
{
"name": "pageSize",
"description": "The number of items to return",
"in": "query",
"required": false,
"schema": {
"default": 100,
"minimum": 1,
"maximum": 10000,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event-deleted-response"
}
}
}
}
}
}
},
"/web/content-connector/events/{entityType}": {
"get": {
"tags": [
"public-events"
],
"description": "Endpoint to get all entities. Context only of the tenant extracted from the security context.",
"operationId": "get-events",
"security": [
{
"haiiloToken": []
}
],
"parameters": [
{
"name": "entityType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/entity-type"
}
},
{
"name": "startId",
"in": "query",
"required": false,
"schema": {
"default": 0,
"minimum": 0,
"type": "integer"
}
},
{
"name": "pageSize",
"description": "The number of items to return",
"in": "query",
"required": false,
"schema": {
"default": 100,
"minimum": 1,
"maximum": 10000,
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "A paginated list of items",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"amount": {
"type": "integer"
},
"lastEventId": {
"type": "integer",
"format": "int64"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/event"
}
}
}
}
}
}
}
}
}
},
"/web/content-connector/theme-icon": {
"get": {
"tags": [
"public-events"
],
"description": "Endpoint to an icon from the default theme. Context only of the tenant extracted from the security context.",
"operationId": "get-theme-icon",
"security": [
{
"haiiloToken": []
}
],
"parameters": [
{
"name": "iconType",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/icon-enum"
}
},
{
"name": "theme",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/theme-enum"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/png": {
"schema": {
"type": "Resource"
}
}
}
}
}
}
},
"/web/content-connector/api/senders/{senderId}/images/{imageType}": {
"get": {
"tags": [
"public-events"
],
"description": "Endpoint to get images avatar or cover from imageUrls params of events",
"operationId": "get-image",
"security": [
{
"haiiloToken": []
}
],
"parameters": [
{
"name": "senderId",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/sender-id"
}
},
{
"name": "imageType",
"in": "path",
"required": true,
"schema": {
"type": "string",
"pattern": "avatar|cover"
}
},
{
"name": "modified",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DTO with Download link",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"imageUrl": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/web/content-connector/api/blogs/{blogId}/teaser": {
"get": {
"tags": [
"public-events"
],
"description": "Endpoint to get blog teaser images download urls",
"operationId": "get-teaser",
"security": [
{
"haiiloToken": []
}
],
"parameters": [
{
"name": "blogId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/blog-teaser-response"
}
}
}
}
}
}
},
"/web/content-connector/api/files/{groupId}/{uid}": {
"get": {
"tags": [
"public-files"
],
"description": "Endpoint to get a download url for a file",
"operationId": "get-file",
"security": [
{
"haiiloToken": []
}
],
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "uid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DTO with Download link",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fileUrl": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/web/content-connector/integrations/{integration}": {
"get": {
"description": "Endpoint to get an integration.",
"security": [
{
"haiiloToken": []
}
],
"tags": [
"public-integrations"
],
"operationId": "get-integration",
"parameters": [
{
"name": "integration",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/integration-type"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/integration"
}
}
}
}
}
},
"put": {
"description": "Endpoint to update an integration.",
"security": [
{
"haiiloToken": []
}
],
"tags": [
"public-integrations"
],
"operationId": "update-integration",
"parameters": [
{
"name": "integration",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/integration-type"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/integration"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "NO_CONTENT"
}
}
}
},
"/web/content-connector/enterprise-search/api-clients": {
"post": {
"description": "Endpoint to create an enterprise search api client.",
"security": [
{
"haiiloToken": []
}
],
"tags": [
"public-enterprise-search-api-client"
],
"operationId": "create-api-client",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-client"
}
}
}
}
}
},
"get": {
"description": "Endpoint to get all enterprise search api clients.",
"security": [
{
"haiiloToken": []
}
],
"tags": [
"public-enterprise-search-api-client"
],
"operationId": "get-api-clients",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/api-client"
}
}
}
}
}
}
}
},
"/web/content-connector/enterprise-search/api-clients/{clientId}/secret": {
"patch": {
"description": "Endpoint to reset the secret of an enterprise search api client.",
"security": [
{
"haiiloToken": []
}
],
"tags": [
"public-enterprise-search-api-client"
],
"operationId": "reset-api-client-secret",
"parameters": [
{
"name": "clientId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-client"
}
}
}
}
}
}
},
"/web/content-connector/enterprise-search/api-clients/{clientId}": {
"delete": {
"description": "Endpoint to delete the enterprise-search api client.",
"security": [
{
"haiiloToken": []
}
],
"tags": [
"public-enterprise-search-api-client"
],
"operationId": "delete-api-client",
"parameters": [
{
"name": "clientId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "NO_CONTENT"
}
}
}
},
"/web/content-connector/icons/{tenantId}": {
"get": {
"tags": [
"public-icons"
],
"operationId": "get-icon",
"parameters": [
{
"name": "tenantId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/png": {
"schema": {
"type": "Resource"
}
}
}
}
}
}
},
"/{tenantId}/connection": {
"post": {
"security": [
{
"basicAuth": []
}
],
"tags": [
"manage-microsoft"
],
"operationId": "create-tenant-connection",
"servers": [
{
"url": "http://localhost:8075/manage/microsoft"
}
],
"parameters": [
{
"name": "tenantId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "NO_CONTENT"
}
}
},
"get": {
"security": [
{
"basicAuth": []
}
],
"tags": [
"manage-microsoft"
],
"operationId": "get-tenant-connection",
"servers": [
{
"url": "http://localhost:8094/manage/microsoft"
}
],
"parameters": [
{
"name": "tenantId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "ExternalConnection"
}
}
}
}
}
}
},
"/{tenantId}/schema": {
"post": {
"security": [
{
"basicAuth": []
}
],
"tags": [
"manage-microsoft"
],
"operationId": "create-tenant-schema",
"servers": [
{
"url": "http://localhost:8075/manage/microsoft"
}
],
"parameters": [
{
"name": "tenantId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "NO_CONTENT"
}
}
}
},
"/{tenantId}/item": {
"post": {
"security": [
{
"basicAuth": []
}
],
"tags": [
"manage-microsoft"
],
"operationId": "create-tenant-item",
"servers": [
{
"url": "http://localhost:8075/manage/microsoft"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/external-item"
}
}
},
"required": true
},
"parameters": [
{
"name": "tenantId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "ExternalItem"
}
}
}
}
}
}
},
"/{tenantId}/item/{itemId}": {
"delete": {
"security": [
{
"basicAuth": []
}
],
"tags": [
"manage-microsoft"
],
"operationId": "delete-tenant-item",
"servers": [
{
"url": "http://localhost:8075/manage/microsoft"
}
],
"parameters": [
{
"name": "tenantId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "NO_CONTENT"
}
}
}
},
"/{tenantId}/resync": {
"post": {
"security": [
{
"basicAuth": []
}
],
"tags": [
"manage-trap"
],
"operationId": "update-entities",
"servers": [
{
"url": "http://localhost:8075/manage/trap"
}
],
"parameters": [
{
"name": "tenantId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/trap-update-request"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "NO Content"
}
}
}
},
"/internal/feature-states": {
"get": {
"tags": [
"internal-feature-states"
],
"operationId": "getFeatureStates",
"parameters": [
{
"name": "tenantId",
"schema": {
"type": "string",
"format": "string"
},
"in": "query"
},
{
"name": "userId",
"schema": {
"type": "string",
"format": "string",
"default": "SYSTEM"
},
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/feature-state"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"event-deleted-response": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"eventId": {
"type": "integer",
"format": "int64"
},
"entityId": {
"type": "string"
},
"entityType": {
"type": "string"
}
}
}
},
"lastEventId": {
"type": "integer",
"format": "int64"
},
"amount": {
"type": "integer"
}
}
},
"sender-id": {
"type": "string",
"description": "The owner of the image.",
"format": "uuid"
},
"entity-type": {
"type": "string",
"description": "The type of the event."
},
"event": {
"type": "object",
"properties": {
"eventId": {
"type": "integer",
"format": "int64",
"description": "The id of the event"
},
"entityType": {
"type": "string",
"description": "The type of the entity"
},
"entityId": {
"type": "string",
"description": "The id of the entity"
},
"eventType": {
"type": "string",
"description": "The type of the event"
},
"tenantId": {
"type": "string",
"description": "The id of the tenant"
}
},
"discriminator": {
"propertyName": "entityType",
"mapping": {
"user": "#/components/schemas/user-event",
"app": "#/components/schemas/app-event",
"timeline-item": "#/components/schemas/timeline-item-event",
"blog-article": "#/components/schemas/blog-article-event",
"wiki-article": "#/components/schemas/wiki-article-event",
"page": "#/components/schemas/page-event",
"workspace": "#/components/schemas/workspace-event",
"event": "#/components/schemas/event-event",
"file": "#/components/schemas/file-event",
"target-segments": "#/components/schemas/target-segments-event",
"comment": "#/components/schemas/comment-event"
}
}
},
"timeline-item-event": {
"allOf": [
{
"$ref": "#/components/schemas/event"
}
],
"description": "An event for a timeline item",
"properties": {
"id": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"itemType": {
"type": "string"
},
"remoteReference": {
"type": "string"
},
"originalAuthorId": {
"type": "string"
},
"author": {
"type": "string"
},
"recipientIds": {
"type": "array",
"items": {
"type": "string"
}
},
"shares": {
"type": "array",
"items": {
"$ref": "#/components/schemas/share"
}
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attachment"
}
},
"data": {
"type": "object"
},
"status": {
"$ref": "#/components/schemas/timeline-item-status"
},
"targetSegments": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"timeline-item-status": {
"type": "string",
"enum": [
"VISIBLE",
"HIDDEN"
]
},
"share": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"authorId": {
"type": "string"
},
"originalAuthorId": {
"type": "string"
},
"recipientId": {
"type": "string"
},
"data": {
"type": "object"
}
}
},
"attachment": {
"type": "object",
"properties": {
"contentType": {
"type": "string"
},
"metaData": {
"type": "object",
"properties": {
"length": {
"type": "number"
},
"storage": {
"type": "string",
"enum": [
"LOCAL_BLOB_STORAGE",
"LOCAL_FILE_LIBRARY",
"G_SUITE",
"OFFICE_365"
]
},
"imageMetadata": {
"type": "object",
"properties": {
"orientation": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"description": {
"type": "string"
}
}
}
}
},
"name": {
"type": "string"
}
}
},
"blog-article-event": {
"allOf": [
{
"$ref": "#/components/schemas/event"
}
],
"description": "A blog article event",
"properties": {
"id": {
"type": "string"
},
"appId": {
"type": "string"
},
"published": {
"type": "boolean"
},
"defaultLanguage": {
"type": "string"
},
"title": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"textContent": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"teaser": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"imageAltText": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"commentsEnabled": {
"type": "boolean"
},
"teaserImage": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"teaserWidgetImage": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"context": {
"$ref": "#/components/schemas/sender-reference"
},
"target": {
"$ref": "#/components/schemas/target"
},
"author": {
"$ref": "#/components/schemas/sender-reference"
},
"originalAuthor": {
"$ref": "#/components/schemas/sender-reference"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"publishedDate": {
"type": "string",
"format": "date-time"
},
"archiveDate": {
"type": "string",
"format": "date-time"
}
}
},
"sender-reference": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"target": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Always lowercase, e.g. \"user_profile\" or \"email_activation\" or \"home\"."
},
"displayName": {
"type": "string",
"description": "Optional display name that might be shown to the user to identify the target."
},
"params": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of key-value pairs representing parameters for the target."
}
},
"required": [
"name"
],
"description": "A location target in the frontend."
},
"wiki-article-event": {
"allOf": [
{
"$ref": "#/components/schemas/event"
}
],
"properties": {
"id": {
"type": "string"
},
"appId": {
"type": "string"
},
"context": {
"$ref": "#/components/schemas/sender-reference"
},
"parentId": {
"type": "string"
},
"title": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"textContent": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"imageAltText": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"defaultLanguage": {
"type": "string"
},
"draft": {
"type": "boolean"
},
"target": {
"$ref": "#/components/schemas/target"
},
"author": {
"$ref": "#/components/schemas/sender-reference"
},
"originalAuthor": {
"$ref": "#/components/schemas/sender-reference"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"archiveDate": {
"type": "string",
"format": "date-time"
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"page-status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED"
],
"description": "The status of the page."
},
"page-visibility": {
"type": "string",
"enum": [
"PUBLIC",
"PRIVATE"
],
"description": "The visibility of the page."
},
"page-event": {
"allOf": [
{
"$ref": "#/components/schemas/event"
}
],
"properties": {
"id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/page-status"
},
"visibility": {
"$ref": "#/components/schemas/page-visibility"
},
"defaultLanguage": {
"type": "string"
},
"availableLanguages": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"description": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"members": {
"type": "array",
"items": {
"type": "string"
}
},
"admins": {
"type": "array",
"items": {
"type": "string"
}
},
"memberGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"adminGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"imageUrls": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"target": {
"$ref": "#/components/schemas/target"
},
"initials": {
"type": "string"
},
"color": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
}
}
},
"workspace-status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"ARCHIVED"
],
"description": "The status of the workspace."
},
"workspace-visibility": {
"type": "string",
"enum": [
"PUBLIC",
"PROTECTED",
"PRIVATE"
],
"description": "The visibility of the workspace."
},
"workspace-locale-data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"description": "Data associated with a specific locale."
},
"workspace-event": {
"allOf": [
{
"$ref": "#/components/schemas/event"
}
],
"properties": {
"status": {
"$ref": "#/components/schemas/workspace-status"
},
"visibility": {
"$ref": "#/components/schemas/workspace-visibility"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"defaultLanguage": {
"type": "string"
},
"localeData": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/workspace-locale-data"
}
},
"imageUrls": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"members": {
"type": "array",
"items": {
"type": "string"
}
},
"admins": {
"type": "array",
"items": {
"type": "string"
}
},
"target": {
"$ref": "#/components/schemas/target"
},
"initials": {
"type": "string"
},
"color": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
}
}
},
"user-status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"HIDDEN",
"DELETED"
],
"description": "The status of the user."
},
"user-event": {
"allOf": [
{
"$ref": "#/components/schemas/event"
}
],
"properties": {
"id": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"displayName": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"external": {
"type": "boolean"
},
"status": {
"$ref": "#/components/schemas/user-status"
},
"properties": {
"type": "object"
},
"target": {
"$ref": "#/components/schemas/target"
},
"initials": {
"type": "string"
},
"color": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"groupIds": {
"type": "array",
"items": {
"type": "string"
}
},
"locale": {
"type": "string"
},
"timezone": {
"type": "string"
},
"imageUrls": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"manager": {
"type": "string"
}
}
},
"app-visibility": {
"type": "string",
"enum": [
"PUBLIC",
"PRIVATE"
],
"description": "The visibility of the app."
},
"app-event": {
"allOf": [
{
"$ref": "#/components/schemas/event"
}
],
"properties": {
"id": {
"type": "string"
},
"active": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"visibility": {
"$ref": "#/components/schemas/app-visibility"
},
"parentId": {
"type": "string"
},
"textContent": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"imageAltText": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"type": {
"type": "string"
},
"name": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"defaultLanguage": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"context": {
"$ref": "#/components/schemas/sender-reference"
},
"target": {
"$ref": "#/components/schemas/target"
},
"settings": {
"type": "object"
}
}
},
"file-event": {
"allOf": [
{
"$ref": "#/components/schemas/event"
}
],
"properties": {
"id": {
"type": "string"
},
"context": {
"$ref": "#/components/schemas/sender-reference"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"folder": {
"type": "boolean"
},
"authorId": {
"type": "string"
},
"contentType": {
"type": "string"
},
"length": {
"type": "number"
},
"description": {
"type": "string"
},
"textContent": {
"type": "string"
},
"currentVersionBlobReference": {
"description": "The reference to the blob data of the current version of the file.",
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"uid": {
"type": "string"
},
"contentType": {
"type": "string"
}
}
},
"appId": {
"type": "string",
"description": "The id of the app that created the file."
},
"parentId": {
"type": "string",
"description": "The parent id of the file."
}
}
},
"target-segments-event": {
"allOf": [
{
"$ref": "#/components/schemas/event"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"targetEntityId": {
"type": "string"
},
"targetType": {
"type": "string",
"enum": [
"PAGE"
]
},
"userIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
"event-status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED"
]
},
"event-visibility": {
"type": "string",
"enum": [
"PUBLIC",
"PRIVATE"
]
},
"event-event": {
"allOf": [
{
"$ref": "#/components/schemas/event"
}
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"place": {
"type": "string"
},
"description": {
"type": "string"
},
"startDate": {
"type": "string",
"format": "local-time"
},
"startTimestamp": {
"type": "number"
},
"endDate": {
"type": "string",
"format": "local-time"
},
"endTimestamp": {
"type": "number"
},
"timezone": {
"type": "string"
},
"creatorId": {
"type": "string"
},
"hostId": {
"type": "string"
},
"attenderIds": {
"type": "array",
"items": {
"type": "string"
}
},
"allInviteeIds": {
"type": "array",
"items": {
"type": "string"
}
},
"imageUrls": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Deprecated since version 46.0.0"
},
"imageWebUrls": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"visibility": {
"$ref": "#/components/schemas/event-visibility"
},
"status": {
"$ref": "#/components/schemas/event-status"
},
"target": {
"$ref": "#/components/schemas/target"
},
"initials": {
"type": "string"
},
"color": {
"type": "string"
}
}
},
"comment-status": {
"type": "string",
"enum": [
"VISIBLE",
"HIDDEN"
]
},
"comment-event": {
"allOf": [
{
"$ref": "#/components/schemas/event"
}
],
"properties": {
"authorId": {
"type": "string"
},
"originalAuthorId": {
"type": "string"
},
"targetId": {
"type": "string"
},
"targetType": {
"type": "string"
},
"parentCommentId": {
"type": "string"
},
"message": {
"type": "string"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attachment"
}
},
"status": {
"$ref": "#/components/schemas/comment-status"
}
}
},
"theme-enum": {
"type": "string",
"default": "DEFAULT",
"enum": [
"DEFAULT"
]
},
"icon-enum": {
"default": "APPLE_ICON",
"type": "string",
"enum": [
"APPLE_ICON"
]
},
"integration-type": {
"type": "string",
"description": "The affected integration. Possible values are 'microsoft, 'enterprisesearch'."
},
"integration": {
"description": "The affected vendor config. Credentials e.g. apiKey hidden by the placeholder '************'. The value won't be changed as long as this placeholder value is used in updated requests.",
"oneOf": [
{
"$ref": "#/components/schemas/microsoft"
},
{
"$ref": "#/components/schemas/enterprise-search"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"microsoft": "#/components/schemas/microsoft",
"enterprise-search": "#/components/schemas/enterprise-search"
}
}
},
"microsoft": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "microsoft",
"example": "microsoft",
"readOnly": true
},
"enabled": {
"type": "boolean",
"default": false
},
"available": {
"type": "boolean",
"default": false
},
"tenantId": {
"type": "string"
},
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"connectionName": {
"type": "string"
},
"blogInitialSync": {
"$ref": "#/components/schemas/blog-initial-sync"
}
},
"required": [
"id",
"enabled",
"tenantId",
"clientId",
"clientSecret",
"connectionName",
"blogInitialSync"
]
},
"enterprise-search": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "enterprise-search",
"example": "enterprise-search",
"readOnly": true
},
"enabled": {
"type": "boolean",
"default": false
},
"searchEnabled": {
"type": "boolean",
"default": false
},
"available": {
"type": "boolean",
"default": false
},
"endpoint": {
"type": "string"
},
"searchUrl": {
"type": "string",
"format": "uri"
},
"searchPluginId": {
"type": "string"
}
},
"required": [
"id",
"enabled"
]
},
"api-client": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
}
},
"required": [
"clientId",
"clientSecret"
]
},
"feature-state": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"states": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"icon": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"name",
"states",
"categories",
"icon"
]
},
"external-item": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"itemType": {
"type": "string"
},
"creator": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"content": {
"type": "string"
}
},
"required": [
"id",
"itemType",
"title",
"url",
"iconUrl",
"content"
]
},
"blog-initial-sync": {
"type": "integer",
"format": "int32",
"description": "Items last modified within specified number of days will be synced.",
"enum": [
30,
60,
90,
180,
365
]
},
"trap-update-request": {
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"types"
]
},
"blog-teaser-response": {
"type": "object",
"properties": {
"image": {
"$ref": "#/components/schemas/teaser-resource",
"description": "The teaser image"
},
"imageWide": {
"$ref": "#/components/schemas/teaser-resource",
"description": "The teaser wide image"
}
}
},
"teaser-resource": {
"type": "object",
"properties": {
"contentType": {
"type": "string",
"description": "The content type of the resource"
},
"downloadUrl": {
"type": "string",
"description": "The download url of the resource"
},
"validityMinutes": {
"type": "integer",
"description": "The validity of the download url in minutes"
}
}
}
},
"securitySchemes": {
"basicAuth": {
"type": "http",
"scheme": "basic"
},
"haiiloToken": {
"type": "http",
"scheme": "bearer",
"description": "Haiilo's internal JWT token issued by the Haiilo Home backend monolith (aka CSI)"
}
}
}
}