{ "openapi": "3.0.0", "paths": { "/api/ai/v1/kb": { "post": { "operationId": "AIV1Controller_createKnowledgebase", "parameters": [], "requestBody": { "required": true, "description": "Knowledgebase", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateKnowledgebaseDTO" } } } }, "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/v1" ] } }, "/api/ai/v1/kb/{id}": { "put": { "operationId": "AIV1Controller_updateKnowledgebase", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "Knowledgebase", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateKnowledgebaseDTO" } } } }, "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/v1" ] }, "delete": { "operationId": "AIV1Controller_deleteKnowledgebase", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/v1" ] } }, "/api/ai/v1/kb/{id}/bulk": { "post": { "operationId": "AIV1Controller_createDocBulk", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "Knowledge documents", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeDocument" } } } } }, "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/v1" ] } }, "/api/ai/v1/kb/{id}/process": { "post": { "operationId": "AIV1Controller_start", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/v1" ] } }, "/api/ai/v1/kb/{id}/status": { "get": { "operationId": "AIV1Controller_getStatus", "parameters": [ { "name": "ids", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/v1" ] } }, "/api/ai/v1/file": { "post": { "operationId": "AIV1Controller_create", "parameters": [], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/v1" ] } }, "/api/ai/v1/chatkit/sessions": { "post": { "operationId": "AIV1Controller_createChatkitSession", "parameters": [], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/v1" ] } }, "/api/ai/contexts/file": { "post": { "operationId": "ContextsController_create", "parameters": [], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Contexts" ] } }, "/api/ai/contexts/file/{id}": { "delete": { "operationId": "ContextsController_delete", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Contexts" ] } }, "/api/ai/knowledges": { "post": { "operationId": "KnowledgesController_createKnowledgebase", "parameters": [], "requestBody": { "required": true, "description": "Knowledgebase", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateKnowledgebaseDTO" } } } }, "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Knowledges" ] } }, "/api/ai/knowledges/{id}": { "put": { "operationId": "KnowledgesController_updateKnowledgebase", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "Knowledgebase", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateKnowledgebaseDTO" } } } }, "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Knowledges" ] }, "delete": { "operationId": "KnowledgesController_deleteKnowledgebase", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Knowledges" ] } }, "/api/ai/knowledges/{id}/bulk": { "post": { "operationId": "KnowledgesController_createDocBulk", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "description": "Knowledge documents", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeDocument" } } } } }, "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Knowledges" ] } }, "/api/ai/knowledges/{id}/process": { "post": { "operationId": "KnowledgesController_start", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Knowledges" ] } }, "/api/ai/knowledges/{id}/status": { "get": { "operationId": "KnowledgesController_getStatus", "parameters": [ { "name": "ids", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Knowledges" ] } }, "/api/ai/assistants/search": { "post": { "operationId": "AssistantsController_search", "parameters": [], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Assistants" ] } }, "/api/ai/assistants/count": { "post": { "operationId": "AssistantsController_count", "parameters": [], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Assistants" ] } }, "/api/ai/assistants/{id}": { "get": { "operationId": "AssistantsController_getOne", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Assistants" ] } }, "/api/ai/threads": { "post": { "operationId": "ThreadsController_createThread", "parameters": [], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/search": { "post": { "operationId": "ThreadsController_searchThreads", "parameters": [], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/{thread_id}": { "get": { "operationId": "ThreadsController_getThread", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] }, "patch": { "operationId": "ThreadsController_patchThread", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] }, "delete": { "operationId": "ThreadsController_deleteThread", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "202": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/{thread_id}/state": { "get": { "operationId": "ThreadsController_getThreadState", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] }, "post": { "operationId": "ThreadsController_updateThreadState", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/{thread_id}/history": { "post": { "operationId": "ThreadsController_getThreadHistory", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/{thread_id}/copy": { "post": { "operationId": "ThreadsController_copyThread", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/{thread_id}/runs": { "get": { "operationId": "ThreadsController_getThreadRuns", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "limit", "required": true, "in": "query", "schema": { "type": "number" } }, { "name": "offset", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] }, "post": { "operationId": "ThreadsController_createRun", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/{thread_id}/runs/stream": { "post": { "operationId": "ThreadsController_runStream", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "last-event-id", "required": true, "in": "header", "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/{thread_id}/runs/wait": { "post": { "operationId": "ThreadsController_runWait", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/{thread_id}/runs/{run_id}/stream": { "get": { "operationId": "ThreadsController_joinRunStream", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "run_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "last-event-id", "required": true, "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/{thread_id}/runs/{run_id}": { "get": { "operationId": "ThreadsController_getThreadRun", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "run_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/{thread_id}/runs/{run_id}/cancel": { "post": { "operationId": "ThreadsController_cancelThreadRun", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "run_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/threads/{thread_id}/usage": { "get": { "operationId": "ThreadsController_getThreadUsage", "parameters": [ { "name": "thread_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "start", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "end", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Threads" ] } }, "/api/ai/conversations": { "post": { "operationId": "ConversationsController_createConversation", "parameters": [], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] } }, "/api/ai/conversations/search": { "post": { "operationId": "ConversationsController_searchConversations", "parameters": [], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] } }, "/api/ai/conversations/{conversation_id}": { "get": { "operationId": "ConversationsController_getConversation", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] }, "patch": { "operationId": "ConversationsController_updateConversation", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] }, "delete": { "operationId": "ConversationsController_deleteConversation", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "202": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] } }, "/api/ai/conversations/{conversation_id}/messages": { "get": { "operationId": "ConversationsController_listMessages", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "limit", "required": true, "in": "query", "schema": { "type": "number" } }, { "name": "offset", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] }, "post": { "operationId": "ConversationsController_createMessage", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] } }, "/api/ai/conversations/{conversation_id}/messages/search": { "post": { "operationId": "ConversationsController_searchMessages", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] } }, "/api/ai/conversations/{conversation_id}/messages/{message_id}": { "get": { "operationId": "ConversationsController_getMessage", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "message_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] }, "patch": { "operationId": "ConversationsController_updateMessage", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "message_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] }, "delete": { "operationId": "ConversationsController_deleteMessage", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "message_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "202": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] } }, "/api/ai/conversations/{conversation_id}/messages/{message_id}/feedbacks": { "get": { "operationId": "ConversationsController_listFeedbacks", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "message_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "limit", "required": true, "in": "query", "schema": { "type": "number" } }, { "name": "offset", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] }, "post": { "operationId": "ConversationsController_createFeedback", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "message_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] } }, "/api/ai/conversations/{conversation_id}/messages/{message_id}/feedbacks/search": { "post": { "operationId": "ConversationsController_searchFeedbacks", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "message_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] } }, "/api/ai/conversations/{conversation_id}/messages/{message_id}/feedbacks/{feedback_id}": { "get": { "operationId": "ConversationsController_getFeedback", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "message_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "feedback_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] }, "patch": { "operationId": "ConversationsController_updateFeedback", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "message_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "feedback_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] }, "delete": { "operationId": "ConversationsController_deleteFeedback", "parameters": [ { "name": "conversation_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "message_id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "feedback_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "202": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Conversations" ] } }, "/api/ai/store/items": { "get": { "operationId": "StoreController_findAll", "parameters": [ { "name": "namespace", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "key", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "refreshTtl", "required": true, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Store" ] }, "put": { "operationId": "StoreController_putItem", "parameters": [], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Store" ] }, "delete": { "operationId": "StoreController_deleteItem", "parameters": [], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Store" ] } }, "/api/ai/store/namespaces": { "post": { "operationId": "StoreController_namespaces", "parameters": [], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Store" ] } }, "/api/ai/store/items/search": { "post": { "operationId": "StoreController_search", "parameters": [], "responses": { "201": { "description": "" } }, "security": [ { "bearer": [] } ], "tags": [ "AI/Store" ] } } }, "info": { "title": "Xpert AI", "description": "", "version": "1.0", "contact": {} }, "tags": [], "servers": [], "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" } }, "schemas": { "PaginationParams": { "type": "object", "properties": { "select": { "type": "object" }, "relations": { "type": "object" }, "order": { "type": "object" }, "where": { "type": "object" }, "withDeleted": { "type": "boolean" }, "take": { "type": "number", "minimum": 0, "maximum": 50 }, "skip": { "type": "number", "minimum": 0 } }, "required": [ "where" ] }, "CreateUserDTO": { "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "imageUrl": { "type": "string" }, "role": { "type": "object" } }, "required": [ "email", "firstName", "lastName", "imageUrl", "role" ] }, "RegisterUserDTO": { "type": "object", "properties": { "password": { "type": "string" }, "confirmPassword": { "type": "string" }, "user": { "$ref": "#/components/schemas/CreateUserDTO" } }, "required": [ "password", "confirmPassword", "user" ] }, "ChangePasswordRequestDTO": { "type": "object", "properties": { "token": { "type": "string" }, "password": { "type": "string" }, "confirmPassword": { "type": "string" } }, "required": [ "token", "password", "confirmPassword" ] }, "ResetPasswordRequestDTO": { "type": "object", "properties": { "email": { "type": "string" } }, "required": [ "email" ] }, "RolePermission": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "permission": { "type": "string", "enum": [ "SUPER_ADMIN", "ADMIN", "DATA_ENTRY", "EMPLOYEE", "CANDIDATE", "MANAGER", "VIEWER", "TRIAL" ] }, "enabled": { "type": "boolean", "default": false }, "roleId": { "type": "string", "enum": [ "SUPER_ADMIN", "ADMIN", "DATA_ENTRY", "EMPLOYEE", "CANDIDATE", "MANAGER", "VIEWER", "TRIAL" ] } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "permission", "roleId" ] }, "Feature": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "name": { "type": "string" }, "code": { "type": "string" }, "isPaid": { "type": "boolean", "default": false }, "description": { "type": "string", "readOnly": true }, "image": { "type": "string", "readOnly": true }, "link": { "type": "string", "readOnly": true }, "status": { "type": "string" }, "icon": { "type": "string" }, "parent": { "$ref": "#/components/schemas/Feature" }, "parentId": { "type": "string" }, "featureOrganizations": { "$ref": "#/components/schemas/FeatureOrganization" }, "children": { "$ref": "#/components/schemas/Feature" } }, "required": [ "createdAt", "updatedAt", "name", "code", "isPaid", "description", "image", "link", "status", "icon", "parent", "parentId", "featureOrganizations", "children" ] }, "FeatureOrganization": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "feature": { "$ref": "#/components/schemas/Feature" }, "featureId": { "type": "string", "readOnly": true } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "feature", "featureId" ] }, "TenantSetting": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "name", "value" ] }, "ImportRecord": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "entityType": { "type": "string" }, "sourceId": { "type": "string" }, "destinationId": { "type": "string" }, "importDate": { "format": "date-time", "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "entityType", "sourceId", "destinationId", "importDate" ] }, "Tenant": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "name": { "type": "string" }, "organizations": { "$ref": "#/components/schemas/Organization" }, "rolePermissions": { "$ref": "#/components/schemas/RolePermission" }, "featureOrganizations": { "$ref": "#/components/schemas/FeatureOrganization" }, "settings": { "$ref": "#/components/schemas/TenantSetting" }, "importRecords": { "$ref": "#/components/schemas/ImportRecord" } }, "required": [ "createdAt", "updatedAt", "name", "organizations", "rolePermissions", "featureOrganizations", "settings", "importRecords" ] }, "OrganizationContact": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "primaryEmail": { "type": "string" }, "emailAddresses": { "type": "array", "items": { "type": "string" } }, "primaryPhone": { "type": "string" }, "phones": { "type": "array", "items": { "type": "string" } }, "inviteStatus": { "type": "string", "enum": [ "NOT_INVITED", "INVITED", "ACCEPTED" ] }, "notes": { "type": "string" }, "contactType": { "type": "string", "enum": [ "CLIENT", "CUSTOMER", "LEAD" ] }, "imageUrl": { "type": "string", "maxLength": 500 }, "budget": { "type": "string" }, "budgetType": { "type": "string" }, "contact": { "$ref": "#/components/schemas/Contact" }, "contactId": { "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "name", "primaryEmail", "primaryPhone", "inviteStatus", "contactType", "contact", "contactId", "tags" ] }, "Contact": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "address": { "type": "string" }, "address2": { "type": "string" }, "postcode": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "regionCode": { "type": "string" }, "fax": { "type": "string" }, "fiscalInformation": { "type": "string" }, "website": { "type": "string" }, "organization_contacts": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationContact" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "name", "firstName", "lastName", "country", "city", "address", "address2", "regionCode", "organization_contacts" ] }, "Role": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "name": { "type": "string", "enum": [ "SUPER_ADMIN", "ADMIN", "DATA_ENTRY", "EMPLOYEE", "CANDIDATE", "MANAGER", "VIEWER", "TRIAL" ] }, "isSystem": { "type": "boolean", "default": false }, "rolePermissions": { "type": "array", "items": { "$ref": "#/components/schemas/RolePermission" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "name", "isSystem", "rolePermissions", "users" ] }, "UserOrganization": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "isDefault": { "type": "boolean", "default": true }, "isActive": { "type": "boolean", "default": true }, "user": { "$ref": "#/components/schemas/User" }, "userId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "isDefault", "isActive", "user", "userId" ] }, "User": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "thirdPartyId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "minLength": 3, "maxLength": 100 }, "mobile": { "type": "string", "minLength": 3, "maxLength": 20 }, "username": { "type": "string", "minLength": 3, "maxLength": 20 }, "timeZone": { "type": "string" }, "hash": { "type": "string" }, "imageUrl": { "type": "string", "maxLength": 500 }, "preferredLanguage": { "type": "string", "enum": [ "zh-CN", "zh-Hans", "zh-Hant", "en" ] }, "emailVerified": { "type": "boolean" }, "deletedAt": { "type": "string", "format": "date-time" }, "role": { "$ref": "#/components/schemas/Role" }, "roleId": { "type": "string", "readOnly": true }, "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOrganization" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "email", "mobile", "hash", "preferredLanguage", "emailVerified", "roleId", "organizations" ] }, "Employee": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "valueDate": { "format": "date-time", "type": "string" }, "isActive": { "type": "boolean", "default": true }, "short_description": { "type": "string", "maxLength": 200 }, "description": { "type": "string" }, "startedWorkOn": { "format": "date-time", "type": "string" }, "endWork": { "format": "date-time", "type": "string" }, "payPeriod": { "type": "string", "enum": [ "NONE", "BI_WEEKLY", "WEEKLY", "TWICE_PER_MONTH", "MONTHLY" ] }, "billRateValue": { "type": "number" }, "billRateCurrency": { "type": "string", "enum": [ "AFN", "AFA", "ALL", "ALK", "DZD", "ADP", "AOA", "AOK", "AON", "AOR", "ARA", "ARS", "ARM", "ARP", "ARL", "AMD", "AWG", "AUD", "ATS", "AZN", "AZM", "BSD", "BHD", "BDT", "BBD", "BYN", "BYB", "BYR", "BEF", "BEC", "BEL", "BZD", "BMD", "BTN", "BOB", "BOL", "BOV", "BOP", "BAM", "BAD", "BAN", "BWP", "BRC", "BRZ", "BRE", "BRR", "BRN", "BRB", "BRL", "GBP", "BND", "BGL", "BGN", "BGO", "BGM", "BUK", "BIF", "XPF", "KHR", "CAD", "CVE", "KYD", "XAF", "CLE", "CLP", "CLF", "CNX", "CNY", "COP", "COU", "KMF", "CDF", "CRC", "HRD", "HRK", "CUC", "CUP", "CYP", "CZK", "CSK", "DKK", "DJF", "DOP", "NLG", "XCD", "DDM", "ECS", "ECV", "EGP", "GQE", "ERN", "EEK", "ETB", "EUR", "XEU", "FKP", "FJD", "FIM", "FRF", "XFO", "XFU", "GMD", "GEK", "GEL", "DEM", "GHS", "GHC", "GIP", "GRD", "GTQ", "GWP", "GNF", "GNS", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "ISJ", "INR", "IDR", "IRR", "IQD", "IEP", "ILS", "ILP", "ILR", "ITL", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LVL", "LVR", "LBP", "LSL", "LRD", "LYD", "LTL", "LTT", "LUL", "LUC", "LUF", "MOP", "MKD", "MKN", "MGA", "MGF", "MWK", "MYR", "MVR", "MVP", "MLF", "MTL", "MTP", "MRO", "MUR", "MXV", "MXN", "MXP", "MDC", "MDL", "MCF", "MNT", "MAD", "MAF", "MZE", "MZN", "MZM", "MMK", "NAD", "NPR", "ANG", "TWD", "NZD", "NIO", "NIC", "NGN", "KPW", "NOK", "OMR", "PKR", "PAB", "PGK", "PYG", "PEI", "PEN", "PES", "PHP", "PLN", "PLZ", "PTE", "GWE", "QAR", "XRE", "RHD", "RON", "ROL", "RUB", "RUR", "RWF", "SVC", "WST", "SAR", "RSD", "CSD", "SCR", "SLL", "SGD", "SKK", "SIT", "SBD", "SOS", "ZAR", "ZAL", "KRH", "KRW", "KRO", "SSP", "SUR", "ESP", "ESA", "ESB", "LKR", "SHP", "SDD", "SDG", "SDP", "SRD", "SRG", "SZL", "SEK", "CHF", "SYP", "STD", "TJR", "TJS", "TZS", "THB", "TPE", "TOP", "TTD", "TND", "TRY", "TRL", "TMT", "TMM", "USD", "USN", "USS", "UGX", "UGS", "UAH", "UAK", "AED", "UYU", "UYP", "UYI", "UZS", "VUV", "VEF", "VEB", "VND", "VNN", "CHE", "CHW", "XOF", "YDD", "YER", "YUN", "YUD", "YUM", "YUR", "ZRN", "ZRZ", "ZMW", "ZMK", "ZWD", "ZWR", "ZWL" ] }, "reWeeklyLimit": { "type": "number" }, "offerDate": { "format": "date-time", "type": "string" }, "acceptDate": { "format": "date-time", "type": "string" }, "rejectDate": { "format": "date-time", "type": "string" }, "employeeLevel": { "type": "string", "maxLength": 500 }, "anonymousBonus": { "type": "boolean" }, "averageIncome": { "type": "number" }, "averageBonus": { "type": "number" }, "totalWorkHours": { "type": "number" }, "averageExpenses": { "type": "number" }, "show_anonymous_bonus": { "type": "boolean" }, "show_average_bonus": { "type": "boolean" }, "show_average_expenses": { "type": "boolean" }, "show_average_income": { "type": "boolean" }, "show_billrate": { "type": "boolean" }, "show_payperiod": { "type": "boolean" }, "show_start_work_on": { "type": "boolean" }, "isJobSearchActive": { "type": "boolean" }, "linkedInUrl": { "type": "string" }, "facebookUrl": { "type": "string" }, "instagramUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "githubUrl": { "type": "string" }, "gitlabUrl": { "type": "string" }, "upworkUrl": { "type": "string" }, "isVerified": { "type": "boolean" }, "isVetted": { "type": "boolean" }, "totalJobs": { "type": "number" }, "jobSuccess": { "type": "number" }, "user": { "$ref": "#/components/schemas/User" }, "userId": { "type": "string", "readOnly": true } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "payPeriod", "billRateValue", "billRateCurrency", "reWeeklyLimit", "averageIncome", "averageBonus", "totalWorkHours", "averageExpenses", "show_anonymous_bonus", "show_average_bonus", "show_average_expenses", "show_average_income", "show_billrate", "show_payperiod", "show_start_work_on", "isJobSearchActive", "isVerified", "isVetted", "totalJobs", "jobSuccess", "user", "userId" ] }, "Language": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "name": { "type": "string" }, "code": { "type": "string" }, "is_system": { "type": "boolean", "default": true }, "description": { "type": "string" }, "color": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "name", "code", "is_system", "description", "color" ] }, "OrganizationLanguage": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "language": { "$ref": "#/components/schemas/Language" }, "languageCode": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "level": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "language", "languageCode", "name", "level" ] }, "Tag": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "category": { "type": "string", "enum": [ "indicator", "story", "toolset", "xpert" ] }, "label": { "type": "object" }, "description": { "type": "string" }, "color": { "type": "string" }, "icon": { "type": "string" }, "isSystem": { "type": "boolean", "default": false } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "name", "category", "description", "color", "icon", "isSystem" ] }, "Organization": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "profile_link": { "type": "string", "minLength": 3, "maxLength": 100 }, "banner": { "type": "string", "maxLength": 300 }, "totalEmployees": { "type": "number", "maxLength": 4 }, "short_description": { "type": "string", "maxLength": 600 }, "client_focus": { "type": "string" }, "overview": { "type": "string" }, "imageUrl": { "type": "string", "maxLength": 500 }, "currency": { "type": "string", "enum": [ "AFN", "AFA", "ALL", "ALK", "DZD", "ADP", "AOA", "AOK", "AON", "AOR", "ARA", "ARS", "ARM", "ARP", "ARL", "AMD", "AWG", "AUD", "ATS", "AZN", "AZM", "BSD", "BHD", "BDT", "BBD", "BYN", "BYB", "BYR", "BEF", "BEC", "BEL", "BZD", "BMD", "BTN", "BOB", "BOL", "BOV", "BOP", "BAM", "BAD", "BAN", "BWP", "BRC", "BRZ", "BRE", "BRR", "BRN", "BRB", "BRL", "GBP", "BND", "BGL", "BGN", "BGO", "BGM", "BUK", "BIF", "XPF", "KHR", "CAD", "CVE", "KYD", "XAF", "CLE", "CLP", "CLF", "CNX", "CNY", "COP", "COU", "KMF", "CDF", "CRC", "HRD", "HRK", "CUC", "CUP", "CYP", "CZK", "CSK", "DKK", "DJF", "DOP", "NLG", "XCD", "DDM", "ECS", "ECV", "EGP", "GQE", "ERN", "EEK", "ETB", "EUR", "XEU", "FKP", "FJD", "FIM", "FRF", "XFO", "XFU", "GMD", "GEK", "GEL", "DEM", "GHS", "GHC", "GIP", "GRD", "GTQ", "GWP", "GNF", "GNS", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "ISJ", "INR", "IDR", "IRR", "IQD", "IEP", "ILS", "ILP", "ILR", "ITL", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LVL", "LVR", "LBP", "LSL", "LRD", "LYD", "LTL", "LTT", "LUL", "LUC", "LUF", "MOP", "MKD", "MKN", "MGA", "MGF", "MWK", "MYR", "MVR", "MVP", "MLF", "MTL", "MTP", "MRO", "MUR", "MXV", "MXN", "MXP", "MDC", "MDL", "MCF", "MNT", "MAD", "MAF", "MZE", "MZN", "MZM", "MMK", "NAD", "NPR", "ANG", "TWD", "NZD", "NIO", "NIC", "NGN", "KPW", "NOK", "OMR", "PKR", "PAB", "PGK", "PYG", "PEI", "PEN", "PES", "PHP", "PLN", "PLZ", "PTE", "GWE", "QAR", "XRE", "RHD", "RON", "ROL", "RUB", "RUR", "RWF", "SVC", "WST", "SAR", "RSD", "CSD", "SCR", "SLL", "SGD", "SKK", "SIT", "SBD", "SOS", "ZAR", "ZAL", "KRH", "KRW", "KRO", "SSP", "SUR", "ESP", "ESA", "ESB", "LKR", "SHP", "SDD", "SDG", "SDP", "SRD", "SRG", "SZL", "SEK", "CHF", "SYP", "STD", "TJR", "TJS", "TZS", "THB", "TPE", "TOP", "TTD", "TND", "TRY", "TRL", "TMT", "TMM", "USD", "USN", "USS", "UGX", "UGS", "UAH", "UAK", "AED", "UYU", "UYP", "UYI", "UZS", "VUV", "VEF", "VEB", "VND", "VNN", "CHE", "CHW", "XOF", "YDD", "YER", "YUN", "YUD", "YUM", "YUR", "ZRN", "ZRZ", "ZMW", "ZMK", "ZWD", "ZWR", "ZWL" ] }, "valueDate": { "format": "date-time", "type": "string" }, "defaultValueDateType": { "type": "string", "enum": [ "TODAY", "END_OF_MONTH", "START_OF_MONTH" ] }, "isActive": { "type": "boolean", "default": true }, "defaultAlignmentType": { "type": "string" }, "timeZone": { "type": "string" }, "regionCode": { "type": "string" }, "brandColor": { "type": "string" }, "dateFormat": { "type": "string" }, "officialName": { "type": "string" }, "startWeekOn": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "taxId": { "type": "string", "maxLength": 256 }, "numberFormat": { "type": "string" }, "minimumProjectSize": { "type": "string", "enum": [ "1000+", "5000+", "10000+", "25000+", "50000+", "100000+" ] }, "bonusType": { "type": "string", "enum": [ "PROFIT_BASED_BONUS", "REVENUE_BASED_BONUS" ] }, "bonusPercentage": { "type": "number" }, "invitesAllowed": { "type": "boolean" }, "createdDemo": { "type": "boolean" }, "show_income": { "type": "boolean" }, "show_profits": { "type": "boolean" }, "show_bonuses_paid": { "type": "boolean" }, "show_total_hours": { "type": "boolean" }, "show_minimum_project_size": { "type": "boolean" }, "show_projects_count": { "type": "boolean" }, "show_clients_count": { "type": "boolean" }, "show_clients": { "type": "boolean" }, "show_employees_count": { "type": "boolean" }, "inviteExpiryPeriod": { "type": "number" }, "fiscalStartDate": { "format": "date-time", "type": "string" }, "fiscalEndDate": { "format": "date-time", "type": "string" }, "registrationDate": { "format": "date-time", "type": "string" }, "futureDateAllowed": { "type": "boolean" }, "allowManualTime": { "type": "boolean" }, "allowModifyTime": { "type": "boolean" }, "allowDeleteTime": { "type": "boolean" }, "requireReason": { "type": "boolean" }, "requireDescription": { "type": "boolean" }, "requireProject": { "type": "boolean" }, "requireTask": { "type": "boolean" }, "requireClient": { "type": "boolean" }, "timeFormat": { "type": "number", "enum": [ 12, 24 ] }, "separateInvoiceItemTaxAndDiscount": { "type": "boolean" }, "website": { "type": "string" }, "fiscalInformation": { "type": "string" }, "currencyPosition": { "type": "string", "enum": [ "LEFT", "RIGHT" ] }, "discountAfterTax": { "type": "boolean" }, "defaultStartTime": { "type": "string" }, "defaultEndTime": { "type": "string" }, "defaultInvoiceEstimateTerms": { "type": "string" }, "convertAcceptedEstimates": { "type": "boolean" }, "daysUntilDue": { "type": "number" }, "preferredLanguage": { "type": "string", "enum": [ "zh-CN", "zh-Hans", "zh-Hant", "en" ] }, "contact": { "$ref": "#/components/schemas/Contact" }, "contactId": { "type": "string", "readOnly": true }, "employees": { "$ref": "#/components/schemas/Employee" }, "languages": { "$ref": "#/components/schemas/OrganizationLanguage" }, "featureOrganizations": { "$ref": "#/components/schemas/FeatureOrganization" }, "tags": { "$ref": "#/components/schemas/Tag" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "name", "isDefault", "profile_link", "banner", "totalEmployees", "short_description", "client_focus", "overview", "currency", "defaultValueDateType", "isActive", "defaultAlignmentType", "timeZone", "regionCode", "brandColor", "dateFormat", "officialName", "startWeekOn", "taxId", "numberFormat", "minimumProjectSize", "bonusType", "bonusPercentage", "invitesAllowed", "createdDemo", "show_income", "show_profits", "show_bonuses_paid", "show_total_hours", "show_minimum_project_size", "show_projects_count", "show_clients_count", "show_clients", "show_employees_count", "inviteExpiryPeriod", "fiscalStartDate", "fiscalEndDate", "registrationDate", "futureDateAllowed", "allowManualTime", "allowModifyTime", "allowDeleteTime", "requireReason", "requireDescription", "requireProject", "requireTask", "requireClient", "timeFormat", "website", "fiscalInformation", "preferredLanguage", "contact", "contactId", "employees", "languages", "featureOrganizations", "tags" ] }, "UserPreferredLanguageDTO": { "type": "object", "properties": { "preferredLanguage": { "type": "string", "enum": [ "zh-CN", "zh-Hans", "zh-Hant", "en" ] } }, "required": [ "preferredLanguage" ] }, "Object": { "type": "object", "properties": {} }, "UserPasswordDTO": { "type": "object", "properties": { "hash": { "type": "string" }, "password": { "type": "string" } }, "required": [ "hash", "password" ] }, "EmailTemplate": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "languageCode": { "type": "string" }, "mjml": { "type": "string" }, "hbs": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "name", "languageCode", "mjml", "hbs" ] }, "Email": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "content": { "type": "string" }, "email": { "type": "string" }, "isArchived": { "type": "boolean" }, "user": { "$ref": "#/components/schemas/User" }, "userId": { "type": "string" }, "emailTemplate": { "$ref": "#/components/schemas/EmailTemplate" }, "emailTemplateId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "name", "content", "email", "user", "userId", "emailTemplate" ] }, "CustomSmtp": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "fromAddress": { "type": "string", "example": "noreply@domain.com" }, "host": { "type": "string" }, "port": { "type": "number" }, "secure": { "type": "boolean" }, "username": { "type": "string" }, "password": { "type": "string" }, "isValidate": { "type": "boolean", "default": false }, "secretKey": { "type": "string" }, "secretPassword": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "fromAddress", "host", "port", "secure", "username", "password", "isValidate", "secretKey", "secretPassword" ] }, "ValidateCustomSmtpDTO": { "type": "object", "properties": { "fromAddress": { "type": "string", "example": "noreply@domain.com" }, "host": { "type": "string" }, "port": { "type": "number" }, "secure": { "type": "boolean" }, "isValidate": { "type": "boolean", "default": false }, "organizationId": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "fromAddress", "host", "port", "secure", "isValidate", "username", "password" ] }, "CreateCustomSmtpDTO": { "type": "object", "properties": { "fromAddress": { "type": "string", "example": "noreply@domain.com" }, "host": { "type": "string" }, "port": { "type": "number" }, "secure": { "type": "boolean" }, "isValidate": { "type": "boolean", "default": false }, "organizationId": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "fromAddress", "host", "port", "secure", "isValidate", "username", "password" ] }, "Country": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "isoCode": { "type": "string" }, "country": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "isoCode", "country" ] }, "Currency": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "isoCode": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "isoCode", "currency" ] }, "CreateInviteDTO": { "type": "object", "properties": { "emailIds": { "type": "array", "items": { "type": "string" } }, "roleId": { "type": "string" }, "invitedById": { "type": "string" }, "inviteType": { "type": "string" }, "startedWorkOn": { "format": "date-time", "type": "string" } }, "required": [ "emailIds", "roleId", "invitedById", "inviteType", "startedWorkOn" ] }, "Invite": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "token": { "type": "string" }, "email": { "type": "string", "minLength": 3, "maxLength": 100 }, "status": { "type": "string", "enum": [ "INVITED", "ACCEPTED" ] }, "expireDate": { "format": "date-time", "type": "string" }, "actionDate": { "format": "date-time", "type": "string" }, "invitedBy": { "$ref": "#/components/schemas/User" }, "invitedById": { "type": "string" }, "role": { "$ref": "#/components/schemas/Role" }, "roleId": { "type": "string" }, "organizationContact": { "$ref": "#/components/schemas/OrganizationContact" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "email", "status", "invitedById", "roleId" ] }, "StorageFile": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "file": { "type": "string" }, "url": { "type": "string" }, "thumb": { "type": "string" }, "originalName": { "type": "string" }, "encoding": { "type": "string" }, "recordedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "size": { "type": "number" }, "mimetype": { "type": "string" }, "storageProvider": { "type": "string", "enum": [ "LOCAL", "S3", "WASABI", "OSS" ] } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "file", "url", "thumb", "originalName", "encoding", "recordedAt", "deletedAt", "size", "mimetype" ] }, "XpertDraftDslDTO": { "type": "object", "properties": {} }, "OptionParams": { "type": "object", "properties": { "select": { "type": "object" }, "relations": { "type": "object" }, "order": { "type": "object" }, "where": { "type": "object" }, "withDeleted": { "type": "boolean" } }, "required": [ "where" ] }, "CreateKnowledgebaseDTO": { "type": "object", "properties": { "workspaceId": { "type": "string", "format": "uuid", "description": "Integration ID of knowledge base system" }, "name": { "type": "string", "example": "Customer service knowledgebase" }, "description": { "type": "string" }, "permission": { "type": "string", "enum": [ "private", "organization", "public" ], "example": "organization", "description": "Knowledgebase Permission", "default": "private" }, "type": { "type": "string", "enum": [ "standard", "external" ], "example": "standard", "description": "Knowledgebase Type", "default": "standard" }, "recall": { "type": "object", "description": "Recall Options", "example": { "topK": 10, "score": 0.5 } }, "parserConfig": { "type": "object", "description": "Parser Config", "example": { "chunkSize": 1000, "chunkOverlap": 100, "delimiter": "; , ." } }, "integrationId": { "type": "string", "format": "uuid", "description": "Integration ID of knowledge base system" }, "extKnowledgebaseId": { "type": "string" }, "copilotModel": { "type": "object", "description": "Copilot embedding model", "example": { "copilotId": "xxxx", "modelType": "text-embedding", "model": "text-embedding-v4" } } }, "required": [ "workspaceId", "name", "description", "permission", "type", "recall", "parserConfig", "integrationId", "extKnowledgebaseId", "copilotModel" ] }, "Environment": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "workspace": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/XpertWorkspace" } ] }, "workspaceId": { "type": "string", "readOnly": true }, "publishAt": { "type": "string", "format": "date-time", "example": "2023-11-21T06:20:32.232Z" }, "deletedAt": { "type": "string", "format": "date-time", "example": "2024-10-14T06:20:32.232Z" }, "name": { "type": "string" }, "variables": { "type": "object" }, "isDefault": { "type": "boolean" }, "isArchived": { "type": "boolean" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "workspace", "workspaceId", "publishAt", "name" ] }, "XpertWorkspace": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "settings": { "type": "object" }, "owner": { "$ref": "#/components/schemas/User" }, "ownerId": { "type": "string" }, "environments": { "type": "array", "items": { "$ref": "#/components/schemas/Environment" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "owner", "ownerId" ] }, "KnowledgebaseTypeEnum": { "type": "string", "enum": [ "standard", "external" ] }, "KnowledgeStructureEnum": { "type": "string", "enum": [ "general", "parent-child", "qa" ] }, "CopilotProviderModel": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "providerName": { "type": "string" }, "modelName": { "type": "string" }, "modelType": { "type": "string" }, "modelProperties": { "type": "object" }, "isValid": { "type": "boolean" }, "provider": { "$ref": "#/components/schemas/CopilotProvider" }, "providerId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "provider", "providerId" ] }, "CopilotProvider": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "providerName": { "type": "string" }, "providerType": { "type": "string" }, "credentials": { "type": "object" }, "isValid": { "type": "boolean" }, "options": { "type": "object" }, "copilot": { "$ref": "#/components/schemas/Copilot" }, "copilotId": { "type": "string" }, "models": { "type": "array", "items": { "$ref": "#/components/schemas/CopilotProviderModel" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "copilot", "copilotId", "models" ] }, "Copilot": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "role": { "type": "string" }, "showTokenizer": { "type": "boolean" }, "options": { "type": "object" }, "tokenBalance": { "type": "number" }, "modelProvider": { "$ref": "#/components/schemas/CopilotProvider" }, "copilotModel": { "$ref": "#/components/schemas/CopilotModel" }, "copilotModelId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "modelProvider", "copilotModel", "copilotModelId" ] }, "CopilotModel": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "modelType": { "type": "string", "enum": [ "llm", "text-embedding", "rerank", "speech2text", "moderation", "tts", "text2img" ] }, "model": { "type": "string" }, "options": { "type": "object" }, "copilot": { "$ref": "#/components/schemas/Copilot" }, "copilotId": { "type": "string" }, "referencedModel": { "$ref": "#/components/schemas/CopilotModel" }, "referencedId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "copilot", "copilotId", "referencedModel", "referencedId" ] }, "Integration": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "avatar": { "type": "object" }, "slug": { "type": "string", "minLength": 10, "maxLength": 100 }, "provider": { "type": "string" }, "options": { "type": "object" }, "features": { "type": "object" }, "tags": { "$ref": "#/components/schemas/Tag" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "name", "slug", "provider", "tags" ] }, "KnowledgeDocumentPage": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "knowledgebase": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Knowledgebase" } ] }, "knowledgebaseId": { "type": "string", "readOnly": true }, "document": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/KnowledgeDocument" } ] }, "documentId": { "type": "string", "readOnly": true }, "pageContent": { "type": "string" }, "metadata": { "type": "object" }, "status": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "knowledgebase", "knowledgebaseId", "document", "documentId" ] }, "KnowledgeDocumentChunk": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "pageContent": { "type": "string" }, "metadata": { "type": "object" }, "status": { "type": "string" }, "parent": { "description": "Parent document chunk", "allOf": [ { "$ref": "#/components/schemas/KnowledgeDocumentChunk" } ] }, "knowledgebase": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Knowledgebase" } ] }, "knowledgebaseId": { "type": "string", "readOnly": true }, "document": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/KnowledgeDocument" } ] }, "documentId": { "type": "string", "readOnly": true } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "knowledgebase", "knowledgebaseId", "document", "documentId" ] }, "KnowledgeDocument": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "disabled": { "type": "boolean" }, "sourceConfig": { "type": "object" }, "category": { "type": "string", "enum": [ "text", "image", "audio", "video", "sheet", "other" ], "description": "Category of the document" }, "type": { "type": "string", "description": "Type of the file" }, "knowledgebase": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Knowledgebase" } ] }, "knowledgebaseId": { "type": "string", "readOnly": true }, "storageFile": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/StorageFile" } ] }, "storageFileId": { "type": "string", "format": "uuid", "description": "Storage file ID" }, "thumbnail": { "type": "string" }, "parserId": { "type": "string" }, "parserConfig": { "type": "object", "description": "Parser Config", "example": { "chunkSize": 1000, "chunkOverlap": 100, "delimiter": "; , ." } }, "name": { "type": "string" }, "filePath": { "type": "string" }, "fileUrl": { "type": "string" }, "folder": { "type": "string" }, "size": { "type": "number" }, "mimeType": { "type": "string" }, "tokenNum": { "type": "number" }, "chunkNum": { "type": "number" }, "progress": { "type": "number" }, "processMsg": { "type": "string" }, "processBeginAt": { "format": "date-time", "type": "string" }, "processDuation": { "type": "number" }, "status": { "type": "string", "enum": [ "waiting", "validate", "running", "transformed", "splitted", "understood", "embedding", "cancel", "finish", "error" ], "description": "Status of the document process" }, "jobId": { "type": "string" }, "options": { "type": "object" }, "metadata": { "type": "object" }, "draft": { "type": "object" }, "parent": { "description": "Parent document", "allOf": [ { "$ref": "#/components/schemas/KnowledgeDocument" } ] }, "integration": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Integration" } ] }, "integrationId": { "type": "string", "readOnly": true }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeDocumentPage" } }, "chunks": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeDocumentChunk" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "disabled", "knowledgebase", "knowledgebaseId", "storageFile", "storageFileId", "parserConfig", "integration", "integrationId", "pages", "chunks" ] }, "Knowledgebase": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "workspace": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/XpertWorkspace" } ] }, "workspaceId": { "type": "string", "readOnly": true }, "publishAt": { "type": "string", "format": "date-time", "example": "2023-11-21T06:20:32.232Z" }, "deletedAt": { "type": "string", "format": "date-time", "example": "2024-10-14T06:20:32.232Z" }, "name": { "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/KnowledgebaseTypeEnum" } ] }, "structure": { "allOf": [ { "$ref": "#/components/schemas/KnowledgeStructureEnum" } ] }, "language": { "type": "string" }, "avatar": { "type": "object" }, "description": { "type": "string" }, "permission": { "type": "string", "enum": [ "private", "organization", "public" ] }, "copilotModel": { "$ref": "#/components/schemas/CopilotModel" }, "copilotModelId": { "type": "string" }, "rerankModel": { "$ref": "#/components/schemas/CopilotModel" }, "rerankModelId": { "type": "string" }, "visionModel": { "$ref": "#/components/schemas/CopilotModel" }, "visionModelId": { "type": "string" }, "documentNum": { "type": "number" }, "tokenNum": { "type": "number" }, "chunkNum": { "type": "number" }, "similarityThreshold": { "type": "number" }, "vectorSimilarityWeight": { "type": "number" }, "recall": { "type": "object" }, "parserId": { "type": "string" }, "parserConfig": { "type": "object" }, "status": { "type": "string" }, "metadataSchema": { "type": "object" }, "apiEnabled": { "type": "boolean" }, "extKnowledgebaseId": { "type": "string" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeDocument" } }, "integration": { "$ref": "#/components/schemas/Integration" }, "integrationId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "workspace", "workspaceId", "publishAt", "permission", "copilotModel", "copilotModelId", "rerankModel", "rerankModelId", "visionModel", "visionModelId", "apiEnabled", "integration", "integrationId" ] }, "XpertAgent": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "key": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "avatar": { "type": "object" }, "prompt": { "type": "string" }, "promptTemplates": { "type": "object" }, "parameters": { "type": "object" }, "outputVariables": { "type": "object" }, "options": { "type": "object" }, "xpert": { "$ref": "#/components/schemas/Xpert" }, "xpertId": { "type": "string", "readOnly": true }, "copilotModel": { "$ref": "#/components/schemas/CopilotModel" }, "copilotModelId": { "type": "string" }, "team": { "$ref": "#/components/schemas/Xpert" }, "teamId": { "type": "string" }, "leaderKey": { "type": "string" }, "knowledgebaseIds": { "type": "object" }, "toolsetIds": { "type": "object" }, "collaboratorNames": { "type": "object" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "xpert", "xpertId", "copilotModel", "copilotModelId", "team", "teamId" ] }, "Xpert": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "workspace": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/XpertWorkspace" } ] }, "workspaceId": { "type": "string", "readOnly": true }, "publishAt": { "type": "string", "format": "date-time", "example": "2023-11-21T06:20:32.232Z" }, "deletedAt": { "type": "string", "format": "date-time", "example": "2024-10-14T06:20:32.232Z" }, "slug": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "titleCN": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" }, "avatar": { "type": "object" }, "starters": { "type": "object" }, "options": { "type": "object" }, "agentConfig": { "type": "object" }, "summarize": { "type": "object" }, "memory": { "type": "object" }, "features": { "type": "object" }, "version": { "type": "string" }, "latest": { "type": "boolean" }, "releaseNotes": { "type": "string" }, "draft": { "type": "object" }, "graph": { "type": "object" }, "api": { "type": "object" }, "app": { "type": "object" }, "agent": { "$ref": "#/components/schemas/XpertAgent" }, "copilotModel": { "$ref": "#/components/schemas/CopilotModel" }, "copilotModelId": { "type": "string" }, "knowledgebase": { "$ref": "#/components/schemas/Knowledgebase" }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/XpertAgent" } }, "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "workspace", "workspaceId", "publishAt", "agent", "copilotModel", "copilotModelId", "knowledgebase", "agents", "integrations" ] }, "CopilotKnowledge": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "provider": { "type": "string" }, "role": { "type": "string" }, "command": { "type": "string" }, "input": { "type": "string" }, "output": { "type": "string" }, "vector": { "type": "boolean" }, "xpert": { "$ref": "#/components/schemas/Xpert" }, "xpertId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "xpert", "xpertId" ] }, "XpertAgentExecution": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "category": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "object" }, "agentKey": { "type": "string" }, "predecessor": { "type": "string" }, "inputs": { "type": "object" }, "outputs": { "type": "object" }, "messages": { "type": "object" }, "status": { "type": "string", "enum": [ "running", "success", "error", "pending", "timeout", "interrupted" ] }, "error": { "type": "string" }, "elapsedTime": { "type": "number" }, "tokens": { "type": "number" }, "embedTokens": { "type": "number" }, "metadata": { "type": "object" }, "responseLatency": { "type": "number" }, "totalPrice": { "type": "number" }, "currency": { "type": "string" }, "inputTokens": { "type": "number" }, "inputUnitPrice": { "type": "number" }, "inputPriceUnit": { "type": "number" }, "outputTokens": { "type": "number" }, "outputUnitPrice": { "type": "number" }, "outputPriceUnit": { "type": "number" }, "threadId": { "type": "string" }, "checkpointNs": { "type": "string" }, "checkpointId": { "type": "string" }, "channelName": { "type": "string" }, "parent_thread_id": { "type": "string" }, "operation": { "type": "object" }, "parent": { "$ref": "#/components/schemas/XpertAgentExecution" }, "parentId": { "type": "string" }, "subExecutions": { "type": "array", "items": { "$ref": "#/components/schemas/XpertAgentExecution" } }, "xpert": { "$ref": "#/components/schemas/Xpert" }, "xpertId": { "type": "string", "readOnly": true } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "status", "elapsedTime", "tokens", "embedTokens", "responseLatency", "totalPrice", "inputTokens", "inputUnitPrice", "inputPriceUnit", "outputTokens", "outputUnitPrice", "outputPriceUnit", "parent", "parentId", "subExecutions", "xpert", "xpertId" ] }, "ChatMessage": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "parent": { "description": "Parent Message", "allOf": [ { "$ref": "#/components/schemas/ChatMessage" } ] }, "role": { "type": "string" }, "content": { "type": "object" }, "reasoning": { "type": "object" }, "status": { "type": "string" }, "error": { "type": "string" }, "summaryJob": { "type": "object" }, "thirdPartyMessage": { "type": "object" }, "events": { "type": "object" }, "deletedAt": { "type": "string", "format": "date-time" }, "conversation": { "$ref": "#/components/schemas/ChatConversation" }, "conversationId": { "type": "string" }, "execution": { "$ref": "#/components/schemas/XpertAgentExecution" }, "executionId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "role", "status", "conversation", "conversationId", "execution", "executionId" ] }, "XpertProjectVCS": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "project": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/XpertProject" } ] }, "projectId": { "type": "string", "readOnly": true }, "deletedAt": { "type": "string", "format": "date-time", "example": "2024-10-14T06:20:32.232Z" }, "integration": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Integration" } ] }, "integrationId": { "type": "string", "readOnly": true }, "auth": { "type": "object" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "project", "projectId", "integration", "integrationId" ] }, "XpertProjectTaskStep": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "project": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/XpertProject" } ] }, "projectId": { "type": "string", "readOnly": true }, "deletedAt": { "type": "string", "format": "date-time", "example": "2024-10-14T06:20:32.232Z" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "project", "projectId" ] }, "XpertProjectTask": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "project": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/XpertProject" } ] }, "projectId": { "type": "string", "readOnly": true }, "deletedAt": { "type": "string", "format": "date-time", "example": "2024-10-14T06:20:32.232Z" }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/XpertProjectTaskStep" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "project", "projectId" ] }, "XpertProject": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "avatar": { "type": "object" }, "description": { "type": "string" }, "status": { "type": "string" }, "settings": { "type": "object" }, "owner": { "$ref": "#/components/schemas/User" }, "ownerId": { "type": "string" }, "workspace": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/XpertWorkspace" } ] }, "workspaceId": { "type": "string", "readOnly": true }, "copilotModel": { "$ref": "#/components/schemas/CopilotModel" }, "copilotModelId": { "type": "string" }, "vcs": { "$ref": "#/components/schemas/XpertProjectVCS" }, "vcsId": { "type": "string" }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/XpertProjectTask" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "owner", "ownerId", "workspace", "workspaceId", "copilotModel", "copilotModelId", "vcs", "vcsId" ] }, "XpertTask": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "schedule": { "type": "string" }, "options": { "type": "object" }, "timeZone": { "type": "string" }, "prompt": { "type": "string" }, "status": { "type": "string", "enum": [ "paused", "archived", "scheduled" ] }, "xpert": { "$ref": "#/components/schemas/Xpert" }, "xpertId": { "type": "string", "readOnly": true }, "agentKey": { "type": "string", "readOnly": true }, "deletedAt": { "type": "string", "format": "date-time" }, "conversations": { "type": "array", "items": { "$ref": "#/components/schemas/ChatConversation" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "xpert", "xpertId", "agentKey" ] }, "ChatConversation": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "threadId": { "type": "string" }, "title": { "type": "object" }, "status": { "type": "string" }, "options": { "type": "object" }, "error": { "type": "string" }, "operation": { "type": "object" }, "from": { "type": "string" }, "fromEndUserId": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMessage" } }, "xpert": { "$ref": "#/components/schemas/Xpert" }, "xpertId": { "type": "string" }, "project": { "$ref": "#/components/schemas/XpertProject" }, "projectId": { "type": "string" }, "task": { "$ref": "#/components/schemas/XpertTask" }, "taskId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "threadId", "status", "error", "from", "fromEndUserId", "xpert", "xpertId", "project", "projectId", "task", "taskId" ] }, "Collection": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "project": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Project" } ] }, "projectId": { "type": "string" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/Collection" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "project", "projectId" ] }, "StoryWidget": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "key": { "type": "string" }, "name": { "type": "string" }, "story": { "$ref": "#/components/schemas/Story" }, "storyId": { "type": "string" }, "pointId": { "type": "string" }, "point": { "$ref": "#/components/schemas/StoryPoint" }, "options": { "type": "object" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "story", "storyId", "pointId", "point" ] }, "StoryPoint": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "key": { "type": "string" }, "name": { "type": "string" }, "story": { "$ref": "#/components/schemas/Story" }, "storyId": { "type": "string" }, "options": { "type": "object" }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/StoryWidget" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "story", "storyId", "widgets" ] }, "NotificationDestination": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/NotificationDestination" }, "options": { "type": "object" }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "type", "subscriptions" ] }, "Subscription": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "enable": { "type": "boolean" }, "story": { "$ref": "#/components/schemas/Story" }, "storyId": { "type": "string" }, "pointId": { "type": "string" }, "widgetId": { "type": "string" }, "destination": { "$ref": "#/components/schemas/NotificationDestination" }, "destinationId": { "type": "string" }, "options": { "type": "object" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "story", "storyId", "pointId", "widgetId", "destination", "destinationId" ] }, "Story": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "project": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Project" } ] }, "projectId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "CHANGING", "REVIEW", "APPROVED", "REJECTED", "RELEASED", "ARCHIVED" ] }, "collection": { "$ref": "#/components/schemas/Collection" }, "collectionId": { "type": "string" }, "businessArea": { "$ref": "#/components/schemas/BusinessArea" }, "businessAreaId": { "type": "string" }, "model": { "$ref": "#/components/schemas/SemanticModel" }, "modelId": { "type": "string" }, "options": { "type": "object" }, "previewId": { "type": "string" }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/StoryPoint" } }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/StoryWidget" } }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } }, "templateId": { "type": "string" }, "pv": { "type": "number" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "project", "projectId", "status", "collection", "collectionId", "businessArea", "businessAreaId", "model", "modelId", "previewId", "points", "widgets", "subscriptions", "templateId", "pv" ] }, "Project": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "Progressing", "Archived" ] }, "deletedAt": { "type": "string", "format": "date-time", "example": "2024-10-14T06:20:32.232Z" }, "owner": { "$ref": "#/components/schemas/User" }, "ownerId": { "type": "string" }, "stories": { "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "indicators": { "type": "array", "items": { "$ref": "#/components/schemas/Indicator" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "status", "owner", "ownerId", "stories", "indicators" ] }, "Certification": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "owner": { "$ref": "#/components/schemas/User" }, "ownerId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "owner", "ownerId" ] }, "Indicator": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "project": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Project" } ] }, "projectId": { "type": "string" }, "draft": { "type": "object" }, "code": { "type": "string" }, "name": { "type": "string" }, "visible": { "type": "boolean" }, "isApplication": { "type": "boolean" }, "businessArea": { "$ref": "#/components/schemas/BusinessArea" }, "businessAreaId": { "type": "string" }, "type": { "type": "string", "enum": [ "BASIC", "DERIVE" ] }, "model": { "$ref": "#/components/schemas/SemanticModel" }, "modelId": { "type": "string" }, "entity": { "type": "string" }, "unit": { "type": "string" }, "principal": { "type": "string" }, "authentication": { "type": "string" }, "validity": { "type": "string" }, "business": { "type": "string" }, "status": { "type": "string" }, "embeddingStatus": { "type": "string", "enum": [ "processing", "success", "failed", "required" ] }, "error": { "type": "string" }, "options": { "type": "object" }, "publishedAt": { "type": "string", "format": "date-time", "example": "2023-11-21T06:20:32.232Z" }, "certificationId": { "type": "string" }, "certification": { "$ref": "#/components/schemas/Certification" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "project", "projectId", "businessAreaId", "type", "model", "modelId", "entity", "unit", "principal", "authentication", "validity", "business", "status", "embeddingStatus", "error", "publishedAt", "certificationId", "certification" ] }, "BusinessAreaUser": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "isDefault": { "type": "boolean", "default": true }, "isActive": { "type": "boolean", "default": true }, "user": { "$ref": "#/components/schemas/User" }, "userId": { "type": "string" }, "businessArea": { "$ref": "#/components/schemas/BusinessArea" }, "businessAreaId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "isDefault", "isActive", "user", "userId", "businessArea", "businessAreaId" ] }, "BusinessArea": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "type": { "type": "string", "enum": [ "SEMANTIC_MODEL", "STORY", "INDICATOR" ] }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/BusinessArea" }, "indicators": { "type": "array", "items": { "$ref": "#/components/schemas/Indicator" } }, "models": { "type": "array", "items": { "$ref": "#/components/schemas/SemanticModel" } }, "stories": { "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessAreaUser" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "type", "indicators", "models", "stories", "users" ] }, "SemanticModelCache": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "model": { "$ref": "#/components/schemas/SemanticModel" }, "modelId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "model", "modelId" ] }, "Favorite": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "project": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Project" } ] }, "projectId": { "type": "string" }, "type": { "type": "string", "enum": [ "SEMANTIC_MODEL", "STORY", "INDICATOR" ] }, "modelId": { "type": "string" }, "model": { "$ref": "#/components/schemas/SemanticModel" }, "storyId": { "type": "string" }, "story": { "$ref": "#/components/schemas/Story" }, "indicatorId": { "type": "string" }, "indicator": { "$ref": "#/components/schemas/Indicator" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "project", "projectId", "type", "modelId", "model", "storyId", "story", "indicatorId", "indicator" ] }, "SemanticModelRole": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "model": { "$ref": "#/components/schemas/SemanticModel" }, "modelId": { "type": "string", "readOnly": true }, "options": { "type": "object" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "model", "modelId" ] }, "SemanticModel": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "draft": { "type": "object" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "XMLA", "SQL" ] }, "catalog": { "type": "string" }, "cube": { "type": "string" }, "options": { "type": "object" }, "status": { "type": "string", "enum": [ "progressing", "archived" ] }, "owner": { "$ref": "#/components/schemas/User" }, "ownerId": { "type": "string" }, "releaseNotes": { "type": "string" }, "publishAt": { "type": "string", "format": "date-time", "example": "2023-11-21T06:20:32.232Z" }, "dataSource": { "$ref": "#/components/schemas/SemanticModel" }, "dataSourceId": { "type": "string" }, "businessArea": { "$ref": "#/components/schemas/BusinessArea" }, "businessAreaId": { "type": "string" }, "stories": { "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "indicators": { "type": "array", "items": { "$ref": "#/components/schemas/Indicator" } }, "cache": { "type": "array", "items": { "$ref": "#/components/schemas/SemanticModelCache" } }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/Favorite" } }, "queries": { "type": "array", "items": { "$ref": "#/components/schemas/ModelQuery" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/SemanticModelRole" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "type", "catalog", "cube", "status", "owner", "ownerId", "publishAt", "dataSource", "dataSourceId", "businessArea", "businessAreaId", "stories", "indicators", "cache", "favorites", "queries", "roles" ] }, "ModelQuery": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "key": { "type": "string" }, "name": { "type": "string" }, "index": { "type": "number" }, "model": { "$ref": "#/components/schemas/SemanticModel" }, "modelId": { "type": "string" }, "options": { "type": "object" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "key", "name", "model", "modelId" ] }, "CreateSemanticModelDTO": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "draft": { "type": "object" }, "type": { "type": "string", "enum": [ "XMLA", "SQL" ] }, "catalog": { "type": "string" }, "cube": { "type": "string" }, "options": { "type": "object" }, "ownerId": { "type": "string" }, "dataSourceId": { "type": "string" }, "businessAreaId": { "type": "string" }, "queries": { "type": "array", "items": { "$ref": "#/components/schemas/ModelQuery" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/SemanticModelRole" } } }, "required": [ "type", "catalog", "cube", "ownerId", "dataSourceId", "businessAreaId", "queries", "roles" ] }, "UpdateSemanticModelDTO": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "draft": { "type": "object" }, "type": { "type": "string", "enum": [ "XMLA", "SQL" ] }, "catalog": { "type": "string" }, "cube": { "type": "string" }, "options": { "type": "object" }, "ownerId": { "type": "string" }, "dataSourceId": { "type": "string" }, "businessAreaId": { "type": "string" }, "queries": { "type": "array", "items": { "$ref": "#/components/schemas/ModelQuery" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/SemanticModelRole" } } }, "required": [ "type", "catalog", "cube", "ownerId", "dataSourceId", "businessAreaId", "queries", "roles" ] }, "DataSource": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/DataSource" }, "typeId": { "type": "string" }, "useLocalAgent": { "type": "boolean" }, "options": { "type": "object" }, "models": { "type": "array", "items": { "$ref": "#/components/schemas/SemanticModel" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "type", "typeId", "useLocalAgent", "models" ] }, "DataSourceAuthentication": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId" ] }, "SemanticModelEntity": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "caption": { "type": "string" }, "type": { "type": "string", "enum": [ "cube", "dimension" ] }, "options": { "type": "object" }, "job": { "type": "object" }, "schedule": { "type": "object" }, "timeZone": { "type": "string" }, "status": { "type": "string", "enum": [ "paused", "archived", "scheduled" ] }, "model": { "$ref": "#/components/schemas/SemanticModel" }, "modelId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "type", "model", "modelId" ] }, "ApprovalPolicy": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "approvalType": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "name", "description", "approvalType" ] }, "CreateApprovalPolicyDTO": { "type": "object", "properties": { "tenant": { "type": "object" }, "tenantId": { "type": "string" }, "organization": { "type": "object" }, "organizationId": { "type": "string" }, "sentTo": { "type": "string" }, "name": { "type": "string", "readOnly": true }, "description": { "type": "string", "readOnly": true } }, "required": [ "organization", "organizationId", "name" ] }, "UpdateApprovalPolicyDTO": { "type": "object", "properties": { "tenant": { "type": "object" }, "tenantId": { "type": "string" }, "organization": { "type": "object" }, "organizationId": { "type": "string" }, "sentTo": { "type": "string" }, "name": { "type": "string", "readOnly": true }, "description": { "type": "string", "readOnly": true } }, "required": [ "organization", "organizationId", "name" ] }, "PermissionApprovalUser": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "status": { "type": "number" }, "permissionApprovalId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "status", "permissionApprovalId", "userId" ] }, "PermissionApproval": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "status": { "type": "number" }, "createdByName": { "type": "string" }, "min_count": { "type": "number" }, "permissionId": { "type": "string", "readOnly": true }, "permissionType": { "type": "string", "enum": [ "TIME_OFF", "EQUIPMENT_SHARING", "BUSINESS_TRIP", "INDICATOR", "STORY", "BUSINESS_AREA" ] }, "approvalPolicy": { "$ref": "#/components/schemas/ApprovalPolicy" }, "approvalPolicyId": { "type": "string" }, "indicator": { "$ref": "#/components/schemas/Indicator" }, "indicatorId": { "type": "string" }, "userApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionApprovalUser" } } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "status", "createdByName", "min_count", "permissionId", "permissionType", "approvalPolicy", "approvalPolicyId", "indicator", "indicatorId" ] }, "Screenshot": { "type": "object", "properties": { "id": { "type": "string" }, "createdById": { "type": "string" }, "updatedById": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2018-11-21T06:20:32.232Z" }, "tenant": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Tenant" } ] }, "tenantId": { "type": "string", "readOnly": true }, "organization": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Organization" } ] }, "organizationId": { "type": "string", "readOnly": true }, "file": { "type": "string" }, "url": { "type": "string" }, "thumb": { "type": "string" }, "recordedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "size": { "type": "number" }, "storageProvider": { "type": "string", "enum": [ "LOCAL", "S3", "WASABI", "OSS" ] } }, "required": [ "createdAt", "updatedAt", "tenant", "tenantId", "organization", "organizationId", "file", "url", "thumb", "recordedAt", "deletedAt", "size" ] } } } }