{ "info": { "title": "Cognigy.AI REST-ful-API Reference", "version": "4.10.0", "description": "\n### Introduction\nThis is the [OpenAPI 3.0](https://swagger.io/specification/) documentation of the [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)-ful Cognigy.AI API.\n\n### Cross-Origin Resource Sharing\nThis API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/), which allows cross-domain communication from the browser. All responses have a wildcard same-origin header which makes the API completely accessible.\n\n### Authentication\nCognigy.AI offers three forms of authentication:\n- API Key\n- OAuth2\n- BasicAuth\n\nAn API Key is a security token. You can use API Keys in your path or HTTP header. Never expose your API Key and keep it safe and secure. Revoke the API Key if it got exposed or stolen.\n\nOAuth2 is an open protocol to allow secure authorization by web, mobile and desktop applications. For further information see [RFC 6749 - \"The OAuth 2.0 Authorization Framework\"](https://tools.ietf.org/html/rfc6749) and [RFC 6750 - \"The OAuth 2.0 Authorization Framework: Bearer Token Usage\"](https://tools.ietf.org/html/rfc6750).\n\nBasic Auth is only used for API calls regarding the Management-UI.\n\n### Error Handling\nThis API uses HTTP status codes equal or above 400 to indicate errors. Error details are generated in compliance with [RFC 7807 - \"Problem Details for HTTP APIs\"](https://tools.ietf.org/html/rfc7807).\n\nEvery error response contains a traceId, which should be provided to the Cognigy.AI Technical Support when reporting an error.\n", "contact": { "name": "Cognigy Technical Support", "url": "https://www.cognigy.com", "email": "support@cognigy.com" } }, "servers": [ { "url": "https://api-trial.cognigy.ai/new/", "description": "Cognigy.AI API" } ], "components": { "securitySchemes": { "APIKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-Key", "description": "Supply the API Key in the HTTP-Header" }, "APIKeyQueryParam": { "type": "apiKey", "in": "query", "name": "api_key", "description": "Supply the API Key in the Url-Query" }, "OAuth2": { "type": "oauth2", "flows": { "password": { "tokenUrl": "/auth/oauth2/token", "refreshUrl": "/auth/oauth2/token" }, "authorizationCode": { "authorizationUrl": "/auth/oauth2/authorize", "tokenUrl": "/auth/oauth2/token" } } }, "BasicAuth": { "type": "http", "scheme": "basic", "description": "Basic Authentication used by routes designed for the Management-UI." } }, "parameters": { "userIdPathParam": { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "apiKeyIdPathParam": { "in": "path", "name": "apiKeyId", "description": "The Id of an Api Key", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "skillIdPathParam": { "in": "path", "name": "skillId", "description": "The Id of the Alexa-Skill", "required": true, "schema": { "type": "string" } }, "organisationIdPathParam": { "in": "path", "name": "organisationId", "description": "The Id of the Organisation", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "yearQueryParam": { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, "monthQueryParam": { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } }, "sessionIdPathParam": { "in": "path", "name": "sessionId", "description": "The Id of the Session", "required": true, "schema": { "type": "string" } }, "logEntryIdPathParam": { "in": "path", "name": "logEntryId", "description": "The Id of the Log Entry", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "profileIdPathParam": { "in": "path", "name": "profileId", "description": "The Id of the Profile", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "taskIdPathParam": { "in": "path", "name": "taskId", "description": "The Id of the Task", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "recordIdPathParam": { "in": "path", "name": "recordId", "description": "The Id of the Record", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "fileTokenPathParam": { "in": "path", "name": "fileToken", "description": "The token of the File", "required": true, "schema": { "type": "string", "pattern": "/[a-fA-F0-9]{64}/" } }, "connectionIdPathParam": { "in": "path", "name": "connectionId", "description": "The Id of the Connection", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "connectionFieldNamePathParam": { "in": "path", "name": "fieldName", "description": "The name of the Connection field", "required": true, "schema": { "type": "string" } }, "endpointIdPathParam": { "in": "path", "name": "endpointId", "description": "The Id of the Endpoint", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "extensionIdPathParam": { "in": "path", "name": "extensionId", "description": "The Id of the Extension", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "fileIdPathParam": { "in": "path", "name": "fileId", "description": "The Id of the File", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "flowIdPathParam": { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "nodeIdPathParam": { "in": "path", "name": "nodeId", "description": "The Id of the Node", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "intentIdPathParam": { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "learningSentenceIdPathParam": { "in": "path", "name": "learningSentenceId", "description": "The Id of the LearningSentence", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "slotFillerIdPathParam": { "in": "path", "name": "slotFillerId", "description": "The Id of the SlotFiller", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "sentenceIdPathParam": { "in": "path", "name": "sentenceId", "description": "The Id of the Sentence", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "stateIdPathParam": { "in": "path", "name": "stateId", "description": "The Id of the State", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "preferredLocaleIdQueryParam": { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "functionIdPathParam": { "in": "path", "name": "functionId", "description": "The Id of the Function", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "functionInstanceIdPathParam": { "in": "path", "name": "functionInstanceId", "description": "The Id of the Function Instance", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "journeyIdPathParam": { "in": "path", "name": "journeyId", "description": "The Id of the Journey", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "lexiconIdPathParam": { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "entryIdPathParam": { "in": "path", "name": "entryId", "description": "The id of an entry in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "keyphraseIdPathParam": { "in": "path", "name": "keyphraseId", "description": "The id of a keyphrase in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "slotIdPathParam": { "in": "path", "name": "slotId", "description": "The id of a slot in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "localeIdPathParam": { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "nluConnectorIdPathParam": { "in": "path", "name": "nluConnectorId", "description": "The Id of the NLUConnector", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "packageIdPathParam": { "in": "path", "name": "packageId", "description": "The Id of the Package", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "playbookIdPathParam": { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "playbookStepIdPathParam": { "in": "path", "name": "stepId", "description": "The Id of the Playbook Step", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "playbookStepAssertIdPathParam": { "in": "path", "name": "assertId", "description": "The Id of the Playbook Step Assert", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "projectIdPathParam": { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "projectIdQueryParam": { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "snapshotIdPathParam": { "in": "path", "name": "snapshotId", "description": "The Id of the Snapshot", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "acceptHeader": { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, "copyResourceIdQueryParam": { "in": "query", "name": "resourceId", "description": "An Id of a resource within the corresponding project to copy from", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "webfingerResourceQueryParam": { "in": "query", "name": "resource", "required": true, "schema": { "type": "string", "format": "uri" } }, "webfingerRelQueryParam": { "in": "query", "name": "rel", "schema": { "type": "array", "items": { "type": "array", "items": { "type": "string", "enum": [ "idp" ] } } } }, "searchParam": { "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, "messageTypeSearchParam": { "in": "query", "name": "messageType", "required": true, "schema": { "type": "string", "enum": [ "current", "next", "previous" ] } }, "understoodParam": { "in": "query", "name": "understood", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, "intentFoundParam": { "in": "query", "name": "intentFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, "slotFoundParam": { "in": "query", "name": "slotFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, "userSlotsFoundParam": { "in": "query", "name": "userSlotsFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, "systemSlotsFoundParam": { "in": "query", "name": "systemSlotsFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, "typeParam": { "in": "query", "name": "type", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "Greeting", "pAnswer", "nAnswer", "BGreeting" ] } } }, "scoreRangeParam": { "in": "query", "name": "scoreRange", "required": false, "description": "A minimum and maximum range to filter with intent score. Example [0.3,0.6]", "schema": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 } }, "projectQueryParam": { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "filterParam": { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, "limitParam": { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, "skipParam": { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 } }, "sortParam": { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 } }, "nextParam": { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "previousParam": { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "schemas": { "intentDownload": { "type": "string", "description": "Stringified CSV or JSON.", "example": "" }, "LexiconCSV": { "type": "string", "description": "Stringified CSV. A line is comma-separated with fields keyphrase, slots ,synonyms. Quotes in the csv are escaped with backslash (\\\"). Lines are separated with newline (\"\\n\") delimiter.", "example": "\"New Keyphrase\", \"Slot 1, Slot2\", \"Synonym1, Synonym2\"" }, "IBatchCreateOperation": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] } } }, "IBatchUpdateOperation": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object" } } }, "IBatchActionOperation": { "type": "object", "properties": { "op": { "type": "string" }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object" } } }, "IBatchDeleteOperation": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "TLicenseState": { "type": "string", "description": "The state of the license", "example": "valid", "enum": [ "invalid", "valid", "willExpireSoon", "expiredRenewRequired", "expired" ] }, "TChannelType": { "type": "string", "example": "webchat2", "enum": [ "facebook", "alexa", "slack", "google", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat", "webchat2", "dialogflow", "twilio", "twilio-sms", "twilio-autopilot", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya" ] }, "TAuditEventType": { "type": "string", "description": "The type of operation that was performed", "example": "create", "enum": [ "action", "create", "replace", "patch", "delete", "unauthorized" ] }, "TResourceTypeAdditional": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "flowState", "functionInstance", "intent", "keyphrase", "learningsentence", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "snippet", "synonym", "tag", "task", "user", "trainerRecord", "task", "slotFiller" ] }, "TAuditEventChainElementType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "user", "trainerRecord" ] }, "IAuditEventModificationChainElement": { "type": "object", "properties": { "elementId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "elementType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "user", "trainerRecord" ] } } }, "IEntityMeta": { "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "type": "object", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ], "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "TResourceType": { "type": "string", "description": "The type of a resource", "example": "flow", "enum": [ "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet" ] }, "TSearchableResourceType": { "type": "string", "description": "The type of a resource", "example": "endpoint", "enum": [ "endpoint", "extension", "flow", "function", "lexicon", "nluconnector", "playbook", "project", "snapshot" ] }, "TSlotFillerType": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "IAuditEvent_2_0": { "type": "object", "properties": { "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "description": "The timestamp when the action happened", "example": "2020-04-27T14:22:11.000Z" }, "type": { "type": "string", "description": "The type of operation that was performed", "example": "create", "enum": [ "action", "create", "replace", "patch", "delete", "unauthorized" ] }, "user": { "type": "string", "description": "The email of the user who performed the operation", "example": "hans.mustermann@xyz.com" }, "modifiedResources": { "type": "array", "description": "An list of resources in the chain of the modification", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "description": "The id of the resource in the modification chain", "example": "5e997f0cdcfc57730cf32941" }, "resourceType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "user", "trainerRecord" ] } } } }, "payload": { "type": "object", "description": "The raw payload of the operation in case it was tracked", "example": { "name": "new resource name" } } } }, "IAuditEventIndexItem_2_0": { "type": "object", "properties": { "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp when the action happened", "example": "2020-04-27T14:22:11.000Z" }, "type": { "type": "string", "description": "The type of operation that was performed", "example": "create", "enum": [ "action", "create", "replace", "patch", "delete", "unauthorized" ] }, "user": { "type": "string", "description": "The email of the user who performed the operation", "example": "hans.mustermann@xyz.com" }, "modifiedResources": { "type": "array", "description": "A list of resources in the chain of the modification", "items": { "type": "object", "properties": { "elementId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "elementType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "user", "trainerRecord" ] } } } } } }, "IApiKeyData_2_0": { "type": "object", "properties": { "name": { "type": "string" } } }, "IApiKey_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 }, "apiKey": { "type": "string" } } }, "IApiKeyIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "apiKey": { "type": "string" }, "createdAt": { "type": "number" } } }, "ILoginAttempt_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "failed" ] }, "timestamp": { "type": "number" }, "location": { "type": "string" } } }, "ILoginAttemptIndexItem_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "failed" ] }, "timestamp": { "type": "number" }, "location": { "type": "string" } } }, "IProjectMemberData_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "intents", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "admin" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "acl": { "type": "object" }, "allowedLocales": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "IProjectMember_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "intents", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "admin" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "acl": { "type": "object" }, "allowedLocales": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IProjectMemberIndexItem_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IUserData_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" } } }, "IUserDataCreate_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "password": { "type": "string", "description": "Enter password in case of non-sso user" } } }, "IUser_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IUserAcl_2_0": { "type": "object", "properties": { "organisationWide": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "livechat": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } } } }, "projectWide": { "type": "object", "additionalProperties": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "analytics": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "livechat": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "additionalProperties": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "intents", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor" ] } }, "allowedLocales": { "type": "array", "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "primary": { "type": "boolean" } } } } } } } } }, "IUserIndexItem_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IUserAdditional_2_0": { "type": "object", "properties": { "newPassword": { "type": "string" } } }, "IUserMeAdditional_2_0": { "type": "object", "properties": { "oldPassword": { "type": "string" }, "newPassword": { "type": "string" } } }, "IManagementUserAdditional_2_0": { "type": "object", "properties": { "newPassword": { "type": "string" } } }, "IUserUpdate_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "newPassword": { "type": "string" } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IUserUpdateMe_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "oldPassword": { "type": "string" }, "newPassword": { "type": "string" } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IManagementUserUpdate_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "newPassword": { "type": "string" } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IUpdateAnalyticsRecordProperties_2_0": { "type": "object", "properties": { "state": { "type": "string" }, "mode": { "type": "string" }, "userType": { "type": "string" }, "channel": { "type": "string" }, "flowLanguage": { "type": "string" }, "intent": { "type": "string" }, "intentScore": { "type": "number" }, "intentFlow": { "type": "string" }, "flowName": { "type": "string" }, "inHandoverRequest": { "type": "boolean" }, "inHandoverConversation": { "type": "boolean" }, "localeName": { "type": "string" }, "rating": { "type": "number" }, "ratingComment": { "type": "string" }, "entrypointType": { "type": "string" }, "trackedGoals": { "type": "array", "items": { "type": "string" } }, "endpointName": { "type": "string" }, "endpointUrlToken": { "type": "string" }, "handoverEscalations": { "type": "string" }, "snapshotName": { "type": "string" }, "slots": { "type": "object" }, "custom1": { "type": "string" }, "custom2": { "type": "string" }, "custom3": { "type": "string" } } }, "TRelType": { "type": "array", "items": { "type": "string", "enum": [ "idp" ] } }, "IWebfingerRestReturnValue": { "type": "object", "properties": { "subject": { "type": "string", "example": "org:5ce7c2d833ea1e04d7e6c432" }, "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string", "enum": [ "idp" ] }, "properties": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } } ] } } } } } }, "TRel": { "type": "object", "properties": { "rel": { "type": "string", "enum": [ "idp" ] }, "properties": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } } ] } } }, "IIdpRel": { "type": "object", "properties": { "rel": { "type": "string", "enum": [ "idp" ] }, "properties": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } } ] } } }, "TIdpWebfingerProperties": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } } ] }, "INoneIdpWebfingerProperties": { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, "IOidcIdpWebfingerProperties": { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, "ISamlIdpWebfingerProperties": { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } }, "IAlexaSkill_2_0": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } }, "IAmazonUser_2_0": { "type": "object", "properties": { "userId": { "type": "string", "description": "The userId of the amazon user in the platform." }, "accessToken": { "type": "string", "description": "The user's access token that allows platform to make requests to Amazon." }, "refreshToken": { "type": "string", "description": "A refresh token that is used to generate a new access token refresh token pair." } } }, "IAnalyticsQueryFilter_2_0": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "notEquals", "gt", "gte", "lt", "lte" ] }, "values": { "type": "array", "items": { "type": "string" } } } } } } }, "ITopNMessages_2_0": { "type": "object", "properties": { "message": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string" } }, "example": { "message": "I want pizza", "count": 12345, "source": "bot" } }, "IGenerateReportResponse_2_0": { "type": "object", "properties": { "queryHash": { "type": "string" } } }, "ILoadReportByQueryHashResponse_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "done", "error" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "dimension": { "type": "string" }, "measure": { "type": "number" }, "value": { "type": "string" } } } } }, "example": { "status": "done", "data": [ { "dimension": "2021-01", "measure": 0 }, { "dimension": "2021-02", "measure": 1 }, { "dimension": "2021-03", "measure": 0 }, { "dimension": "2021-04", "measure": 1 } ] } }, "TAnalyticsQueryFilterOperator_2_0": { "type": "string", "enum": [ "equals", "notEquals", "gt", "gte", "lt", "lte" ] }, "IOrganisationData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" } } }, "IOrganisation_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IOrganisationPasswordPolicy_2_0": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "IOrganisationIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" } } }, "IUserDataManagement_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" } } }, "IUserManagement_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IUserManagementIndexItem_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IVendor_2_0": { "type": "object", "properties": { "version": { "type": "string", "description": "The product version we are running" }, "frontendBaseUrl": { "type": "string", "description": "Base URL to the frontend UI" }, "hasLicenseAgreement": { "type": "string", "description": "Flag whether users need to agree the license agreement within this env" }, "maxContactProfileTTL": { "type": "number" }, "maxConversationTTL": { "type": "number" }, "maxSessionStateTTL": { "type": "number" } } }, "IConversationCounterAggregatedValue_2_0": { "type": "object", "properties": { "conversations": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" } } }, "IConversationData_2_0": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "projectName": { "type": "string" }, "inputId": { "type": "string" }, "sessionId": { "type": "string" }, "contactId": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "inputText": { "type": "string" }, "inputData": { "type": "object" }, "type": { "type": "string", "example": "user", "enum": [ "input", "output" ] }, "source": { "type": "string", "example": "user", "enum": [ "user", "bot", "agent", "suggestion" ] }, "flowName": { "type": "string" }, "flowReferenceId": { "type": "string" }, "channel": { "type": "string", "example": "webchat2", "enum": [ "facebook", "alexa", "slack", "google", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat", "webchat2", "dialogflow", "twilio", "twilio-sms", "twilio-autopilot", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya" ] }, "timestamp": { "type": "object" }, "inHandoverRequest": { "type": "boolean" }, "inHandoverConversation": { "type": "boolean" }, "outputId": { "type": "string" }, "expiresAt": { "type": "object" }, "endpointUrlToken": { "type": "string" }, "endpointName": { "type": "string" }, "localeReferenceId": { "type": "string" }, "localeName": { "type": "string" }, "snapshotId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "snapshotName": { "type": "string" }, "rating": { "type": "number" }, "ratingComment": { "type": "string" } } }, "IConversationSession_2_0": { "type": "object", "properties": { "_id": { "type": "string" }, "contactId": { "type": "string" }, "channel": { "type": "string", "example": "webchat2", "enum": [ "facebook", "alexa", "slack", "google", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat", "webchat2", "dialogflow", "twilio", "twilio-sms", "twilio-autopilot", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya" ] }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "projectName": { "type": "string" }, "flowName": { "type": "string" }, "messages": { "type": "integer" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "ratings": { "type": "array", "items": { "type": "number" } }, "ratingComments": { "type": "array", "items": { "type": "string" } } } }, "TAnalyticsSource_2_0": { "type": "string", "example": "user", "enum": [ "user", "bot", "agent", "suggestion" ] }, "TAnalyticsType_2_0": { "type": "string", "example": "user", "enum": [ "input", "output" ] }, "ILogEntry_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" } } }, "ILogEntryIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" } } }, "IProfileData_2_0": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "goals": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } } } }, "IProfile_2_0": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "goals": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IFlattenedProfile_2_0": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "goals": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "IProfileIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "goals": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string" } }, "lastChanged": { "type": "number" }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IProfileSchemaData_2_0": { "type": "object", "properties": { "schema": { "type": "object" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "internal": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "object", "number", "boolean" ] } } } } } }, "IProfileSchema_2_0": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "goals": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } } } }, "IProfileSchemaEntry_2_0": { "type": "object", "properties": { "field": { "type": "string" }, "internal": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "object", "number", "boolean" ] } } }, "ITaskData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "currentStep": { "type": "integer" }, "totalStep": { "type": "integer" }, "failReason": { "type": "string" }, "lastRunAt": { "type": "string", "format": "date-time" }, "lastFinishedAt": { "type": "string", "format": "date-time" } } }, "ITask_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "currentStep": { "type": "integer" }, "totalStep": { "type": "integer" }, "failReason": { "type": "string" }, "lastRunAt": { "type": "string", "format": "date-time" }, "lastFinishedAt": { "type": "string", "format": "date-time" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "TTaskStatus_2_0": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "ICreatedTask_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } }, "ITaskIndexItemData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "currentStep": { "type": "integer" }, "lastRunAt": { "type": "string", "format": "date-time" }, "lastFinishedAt": { "type": "string", "format": "date-time" }, "totalStep": { "type": "integer" }, "failReason": { "type": "string" } } }, "ITaskIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "currentStep": { "type": "integer" }, "totalStep": { "type": "integer" }, "failReason": { "type": "string" }, "lastRunAt": { "type": "string", "format": "date-time" }, "lastFinishedAt": { "type": "string", "format": "date-time" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ITaskData_2_1": { "type": "object", "properties": { "type": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "runAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" }, "failReason": { "type": "string" }, "failedAt": { "type": "string", "format": "date-time" } } }, "ITask_2_1": { "type": "object", "properties": { "type": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "runAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" }, "failReason": { "type": "string" }, "failedAt": { "type": "string", "format": "date-time" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "TTaskStatus_2_1": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "ICreatedTask_2_1": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "progress": { "type": "integer", "example": 0 } } }, "ITaskIndexItemData_2_1": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "runAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" }, "failReason": { "type": "string" }, "failedAt": { "type": "string", "format": "date-time" } } }, "ITaskIndexItem_2_1": { "type": "object", "properties": { "type": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "runAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" }, "failReason": { "type": "string" }, "failedAt": { "type": "string", "format": "date-time" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ITrainerRecordData_2_0": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the user", "example": "I want a Pizza" }, "count": { "type": "number", "description": "How often the text was used as an input", "example": 2 }, "flowReferenceId": { "type": "string", "format": "uuid" }, "handled": { "type": "boolean" }, "handleAction": { "type": "string", "enum": [ "addedToIntent", "skip", "ignored" ] }, "nlu": { "type": "object", "description": "The last NLU object that was created (from InputObject) based on the message" }, "meta": { "type": "object" }, "snapshotReference": { "type": "string", "description": "Reference to a snapshot in case this record was created because a user talked to a snapshot" } } }, "ITrainerRecord_2_0": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the user", "example": "I want a Pizza" }, "count": { "type": "number", "description": "How often the text was used as an input", "example": 2 }, "flowReferenceId": { "type": "string", "format": "uuid" }, "handled": { "type": "boolean" }, "handleAction": { "type": "string", "enum": [ "addedToIntent", "skip", "ignored" ] }, "nlu": { "type": "object", "description": "The last NLU object that was created (from InputObject) based on the message" }, "meta": { "type": "object" }, "snapshotReference": { "type": "string", "description": "Reference to a snapshot in case this record was created because a user talked to a snapshot" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ITrainerRecordIndexItem_2_0": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the user", "example": "I want a Pizza" }, "count": { "type": "number", "description": "How often the text was used as an input", "example": 2 }, "flowReferenceId": { "type": "string", "format": "uuid" }, "handled": { "type": "boolean" }, "handleAction": { "type": "string", "enum": [ "addedToIntent", "skip", "ignored" ] }, "nlu": { "type": "object", "description": "The last NLU object that was created (from InputObject) based on the message" }, "meta": { "type": "object" }, "snapshotReference": { "type": "string", "description": "Reference to a snapshot in case this record was created because a user talked to a snapshot" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IChart_2_0": { "type": "object", "properties": { "nodes": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "type": { "type": "string", "example": "if" }, "referenceId": { "type": "string", "format": "uuid" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node" }, "comment": { "type": "string", "example": "this is a very important node" }, "commentColor": { "oneOf": [ { "oneOf": [ { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ff8a80" }, { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isCollapsed": { "type": "boolean", "example": false }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false } } } }, "relations": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "node": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "children": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "next": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ] } } } } } }, "IChartNodeData_2_0": { "type": "object", "properties": { "type": { "type": "string", "example": "if" }, "referenceId": { "type": "string", "format": "uuid" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node" }, "comment": { "type": "string", "example": "this is a very important node" }, "commentColor": { "oneOf": [ { "oneOf": [ { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ff8a80" }, { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "preview": { "example": "This is a fancy node" }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false }, "config": { "type": "object" }, "localeReference": { "type": "string" }, "analyticsLabel": { "type": "string" } } }, "IChartNode_2_0": { "type": "object", "properties": { "type": { "type": "string", "example": "if" }, "referenceId": { "type": "string", "format": "uuid" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node" }, "comment": { "type": "string", "example": "this is a very important node" }, "commentColor": { "oneOf": [ { "oneOf": [ { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ff8a80" }, { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "preview": { "example": "This is a fancy node" }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false }, "config": { "type": "object" }, "localeReference": { "type": "string" }, "analyticsLabel": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IChartNodeIndexItemData_2_0": { "type": "object", "properties": { "type": { "type": "string", "example": "if" }, "referenceId": { "type": "string", "format": "uuid" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node" }, "comment": { "type": "string", "example": "this is a very important node" }, "commentColor": { "oneOf": [ { "oneOf": [ { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ff8a80" }, { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isCollapsed": { "type": "boolean", "example": false }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false } } }, "IChartNodeIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "type": { "type": "string", "example": "if" }, "referenceId": { "type": "string", "format": "uuid" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node" }, "comment": { "type": "string", "example": "this is a very important node" }, "commentColor": { "oneOf": [ { "oneOf": [ { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ff8a80" }, { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isCollapsed": { "type": "boolean", "example": false }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false } } }, "IChartNodeRelation_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "node": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "children": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "next": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ] } } }, "IConnectionDataUpdate_2_0": { "type": "object", "properties": { "fields": { "type": "object", "description": "The fields of the Connection. Key-Value pairs.", "minProperties": 1, "maxProperties": 10, "example": { "apiKey": "x123sdfu12312" } } } }, "IConnectionData": { "type": "object", "properties": { "referenceId": { "type": "string", "description": "The reference id of the Connection", "format": "uuid" }, "name": { "type": "string", "description": "The name of the Connection", "example": "Azure API" }, "fields": { "type": "object", "description": "The fields of the Connection. Key-Value pairs.", "minProperties": 1, "maxProperties": 10, "example": { "apiKey": "x123sdfu12312" } }, "connectionSchema": { "type": "object", "description": "Identifies the schema which should be used to validate the connection fields.", "properties": { "extension": { "type": "string", "description": "The package-name of the extension.", "example": "azure" }, "type": { "type": "string", "description": "The type of the connection defined in the extension.", "example": "oauth2" } } } } }, "IConnection_2_0": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the connection field", "example": "client_id" }, "value": { "type": "string", "description": "The value of the connection field", "example": "x123w123" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IConnectionData_2_0": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the connection field", "example": "client_id" }, "value": { "type": "string", "description": "The value of the connection field", "example": "x123w123" } } }, "IConnectionIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "referenceId": { "type": "string", "description": "The reference id of the Connection", "example": "0f7b5514-e7a5-4947-ae44-7519a23c7403" }, "name": { "type": "string", "description": "The name of the Connection", "example": "azure" }, "connectionSchema": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package-name of the extension." }, "type": { "type": "string", "description": "The type of connection." } } }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IConnectionSchemaData_2_0": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package name of the extension", "example": "azure" }, "type": { "type": "string", "description": "The type of the connection within the extension", "example": "oauth-2" }, "label": { "type": "string", "description": "The label for the connection type", "example": "OAuth-2" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "The name of the field", "example": "client_secret" } } } } } }, "IConnectionSchema_2_0": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package name of the extension", "example": "azure" }, "type": { "type": "string", "description": "The type of the connection within the extension", "example": "oauth-2" }, "label": { "type": "string", "description": "The label for the connection type", "example": "OAuth-2" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "The name of the field", "example": "client_secret" } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IConnectionSchemaIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "extension": { "type": "string", "description": "The package name of the extension this schema was found", "example": "azure" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IEndpointData_2_0": { "type": "object", "properties": { "foreignId": { "type": "string" }, "channel": { "type": "string", "example": "webchat2", "enum": [ "facebook", "alexa", "slack", "google", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat", "webchat2", "dialogflow", "twilio", "twilio-sms", "twilio-autopilot", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya" ] }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "entrypoint": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "active": { "type": "boolean", "description": "Toggle whether the endpoint is active or not" }, "nluConnectorId": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "twilioAutopilotBuiltIn", "luis", "watson", "noNlu", "cognigy", "code" ] }, { "type": "string" } ] }, "useConversations": { "type": "boolean", "description": "Whether to collect conversations history for this endpoint" }, "maskAnalytics": { "type": "boolean", "description": "Whether to mask sensitive data in analytics for this endpoint" }, "maskLogging": { "type": "boolean", "description": "Whether to mask sensitive data in logs for this endpoint" }, "useContactProfiles": { "type": "boolean", "description": "Whether to use contact profiles for this endpoint" }, "useAnalytics": { "type": "boolean", "description": "Whether we should store analytics for this endpoint" }, "useChatbaseAnalytics": { "type": "boolean", "description": "Whether we should use Chatbase to collect analytics" }, "chatbaseApikey": { "type": "string", "description": "The apikey for the Chatbase bot" }, "useDashbotAnalytics": { "type": "boolean", "description": "Whether we should use Dashbot to collect analytics" }, "dashbotApikey": { "type": "string", "description": "The apikey for the dashbot bot" }, "dashbotPlatform": { "type": "string" }, "settings": { "type": "object", "properties": { "accessToken": { "type": "string" }, "appId": { "type": "string" }, "appSecret": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "basicAuthPassword": { "type": "string" }, "basicAuthUser": { "type": "string" }, "botUserId": { "type": "string" }, "colorScheme": { "type": "string" }, "designTemplate": { "type": "integer" }, "disableHtmlContentSanitization": { "type": "boolean" }, "disableUrlButtonSanitization": { "type": "boolean" }, "enableGenericHTMLStyling": { "type": "boolean" }, "displayGetStartedButton": { "type": "boolean" }, "enableFileUpload": { "type": "boolean" }, "enablePersistentMenu": { "type": "boolean" }, "enableRating": { "type": "string", "enum": [ "onRequest", "always", "once" ] }, "enableSTT": { "type": "boolean" }, "enableTTS": { "type": "boolean" }, "enableTypingIndicator": { "type": "boolean" }, "facebookPageToken": { "type": "string" }, "getStartedButtonText": { "type": "string" }, "getStartedPayload": { "type": "string" }, "getStartedText": { "type": "string" }, "headerLogoUrl": { "type": "string" }, "hubSecret": { "type": "string" }, "inputPlaceholder": { "type": "string" }, "language": { "type": "string" }, "lineChannelAccessToken": { "type": "string" }, "lineChannelSecret": { "type": "string" }, "mergeContactProfiles": { "type": "boolean" }, "messageDelay": { "type": "integer" }, "messageLogoUrl": { "type": "string" }, "ratingTitleText": { "type": "string" }, "ratingCommentText": { "type": "string" }, "ratingMessageHistoryRatingText": { "type": "string" }, "ratingMessageHistoryCommentText": { "type": "string" }, "reparseAlexaSlots": { "type": "boolean" }, "requestFacebookProfileData": { "type": "boolean" }, "sessionExpiration": { "type": "integer" }, "slackOAuthAccessToken": { "type": "string" }, "slackVerifyToken": { "type": "string" }, "sunshineConversationsChannelKeyId": { "type": "string" }, "sunshineConversationsChannelSecret": { "type": "string" }, "sunshineConversationsChannelUri": { "type": "string", "format": "uri" }, "updateContactProfileWithFacebookProfile": { "type": "boolean" }, "voice": { "type": "string" }, "webhookUrl": { "type": "string", "format": "uri" }, "skill": { "type": "object" }, "persistentMenu": { "type": "object" } } }, "transformerSettings": { "type": "object", "properties": { "abortOnError": { "type": "boolean", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.\n" }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings.\n" }, "transpiledTransformer": { "type": "string", "description": "The transformer object written by the user, but without typings. This will be executed.\n" }, "inputTransformerEnabled": { "type": "boolean" }, "outputTransformerEnabled": { "type": "boolean" }, "finalPingTransformerEnabled": { "type": "boolean" }, "notifyTransformerEnabled": { "type": "boolean" }, "injectTransformerEnabled": { "type": "boolean" } } }, "handoverSettings": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "cognigy", "none", "rce" ] }, "providerSettings": { "type": "object", "properties": { "forwardOnlyHandoverConversations": { "type": "boolean", "description": "(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.\n" }, "apiAccessToken": { "type": "string", "description": "(rce) The API access token you can create within RCE" }, "baseApiUrl": { "type": "string", "description": "(rce) The API URL to your RCE installation" }, "realtimeAccessToken": { "type": "string", "description": "(rce) The access token for your rce source sdk source" }, "realtimeEndpointUrl": { "type": "string", "description": "(rce) The endpoint URL of your rce source sdk source" }, "webhookSecret": { "type": "string", "description": "(rce) The secret used to secure webhooks in RCE" }, "botCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "agentCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" } } } } } } }, "IEndpoint_2_0": { "type": "object", "properties": { "foreignId": { "type": "string" }, "channel": { "type": "string", "example": "webchat2", "enum": [ "facebook", "alexa", "slack", "google", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat", "webchat2", "dialogflow", "twilio", "twilio-sms", "twilio-autopilot", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya" ] }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "entrypoint": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "active": { "type": "boolean", "description": "Toggle whether the endpoint is active or not" }, "nluConnectorId": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "twilioAutopilotBuiltIn", "luis", "watson", "noNlu", "cognigy", "code" ] }, { "type": "string" } ] }, "useConversations": { "type": "boolean", "description": "Whether to collect conversations history for this endpoint" }, "maskAnalytics": { "type": "boolean", "description": "Whether to mask sensitive data in analytics for this endpoint" }, "maskLogging": { "type": "boolean", "description": "Whether to mask sensitive data in logs for this endpoint" }, "useContactProfiles": { "type": "boolean", "description": "Whether to use contact profiles for this endpoint" }, "useAnalytics": { "type": "boolean", "description": "Whether we should store analytics for this endpoint" }, "useChatbaseAnalytics": { "type": "boolean", "description": "Whether we should use Chatbase to collect analytics" }, "chatbaseApikey": { "type": "string", "description": "The apikey for the Chatbase bot" }, "useDashbotAnalytics": { "type": "boolean", "description": "Whether we should use Dashbot to collect analytics" }, "dashbotApikey": { "type": "string", "description": "The apikey for the dashbot bot" }, "dashbotPlatform": { "type": "string" }, "settings": { "type": "object", "properties": { "accessToken": { "type": "string" }, "appId": { "type": "string" }, "appSecret": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "basicAuthPassword": { "type": "string" }, "basicAuthUser": { "type": "string" }, "botUserId": { "type": "string" }, "colorScheme": { "type": "string" }, "designTemplate": { "type": "integer" }, "disableHtmlContentSanitization": { "type": "boolean" }, "disableUrlButtonSanitization": { "type": "boolean" }, "enableGenericHTMLStyling": { "type": "boolean" }, "displayGetStartedButton": { "type": "boolean" }, "enableFileUpload": { "type": "boolean" }, "enablePersistentMenu": { "type": "boolean" }, "enableRating": { "type": "string", "enum": [ "onRequest", "always", "once" ] }, "enableSTT": { "type": "boolean" }, "enableTTS": { "type": "boolean" }, "enableTypingIndicator": { "type": "boolean" }, "facebookPageToken": { "type": "string" }, "getStartedButtonText": { "type": "string" }, "getStartedPayload": { "type": "string" }, "getStartedText": { "type": "string" }, "headerLogoUrl": { "type": "string" }, "hubSecret": { "type": "string" }, "inputPlaceholder": { "type": "string" }, "language": { "type": "string" }, "lineChannelAccessToken": { "type": "string" }, "lineChannelSecret": { "type": "string" }, "mergeContactProfiles": { "type": "boolean" }, "messageDelay": { "type": "integer" }, "messageLogoUrl": { "type": "string" }, "ratingTitleText": { "type": "string" }, "ratingCommentText": { "type": "string" }, "ratingMessageHistoryRatingText": { "type": "string" }, "ratingMessageHistoryCommentText": { "type": "string" }, "reparseAlexaSlots": { "type": "boolean" }, "requestFacebookProfileData": { "type": "boolean" }, "sessionExpiration": { "type": "integer" }, "slackOAuthAccessToken": { "type": "string" }, "slackVerifyToken": { "type": "string" }, "sunshineConversationsChannelKeyId": { "type": "string" }, "sunshineConversationsChannelSecret": { "type": "string" }, "sunshineConversationsChannelUri": { "type": "string", "format": "uri" }, "updateContactProfileWithFacebookProfile": { "type": "boolean" }, "voice": { "type": "string" }, "webhookUrl": { "type": "string", "format": "uri" }, "skill": { "type": "object" }, "persistentMenu": { "type": "object" } } }, "transformerSettings": { "type": "object", "properties": { "abortOnError": { "type": "boolean", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.\n" }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings.\n" }, "transpiledTransformer": { "type": "string", "description": "The transformer object written by the user, but without typings. This will be executed.\n" }, "inputTransformerEnabled": { "type": "boolean" }, "outputTransformerEnabled": { "type": "boolean" }, "finalPingTransformerEnabled": { "type": "boolean" }, "notifyTransformerEnabled": { "type": "boolean" }, "injectTransformerEnabled": { "type": "boolean" } } }, "handoverSettings": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "cognigy", "none", "rce" ] }, "providerSettings": { "type": "object", "properties": { "forwardOnlyHandoverConversations": { "type": "boolean", "description": "(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.\n" }, "apiAccessToken": { "type": "string", "description": "(rce) The API access token you can create within RCE" }, "baseApiUrl": { "type": "string", "description": "(rce) The API URL to your RCE installation" }, "realtimeAccessToken": { "type": "string", "description": "(rce) The access token for your rce source sdk source" }, "realtimeEndpointUrl": { "type": "string", "description": "(rce) The endpoint URL of your rce source sdk source" }, "webhookSecret": { "type": "string", "description": "(rce) The secret used to secure webhooks in RCE" }, "botCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "agentCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" } } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IEndpointTranslationSettings_2_0": { "type": "object", "properties": { "translationEnabled": { "type": "boolean", "description": "Whether or not Translation is enabled for the Endpoint" }, "flowLanguage": { "type": "string", "description": "The language of the Flow outputs" }, "inputLanguage": { "type": "string", "description": "The language of the user inputs ('auto' for auto-detection)" }, "noTranslateMarker": { "type": "string", "description": "Don't translate inputs and outputs which are prefixed with this prefix" }, "padPayloads": { "type": "boolean", "description": "If true, prevents all user inputs based on payloads to be translated" }, "alwaysRemoveNoTranslateMarker": { "type": "boolean", "description": "Wether we remove No Translation Markers, even if translation is not enabled" }, "setInputLanguageOnExecutionCount": { "type": "boolean", "description": "If the input language is set to 'auto', it will be fixed to its current value on this execution count" } } }, "IEndpointIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "flowId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "channel": { "type": "string", "example": "webchat2", "enum": [ "facebook", "alexa", "slack", "google", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat", "webchat2", "dialogflow", "twilio", "twilio-sms", "twilio-autopilot", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IExtensionData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Extension", "example": "New Extension" }, "label": { "type": "string", "description": "The label of the Extension", "example": "New Extension" }, "version": { "type": "string", "description": "The version of the Extension", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$", "example": "1.0.0" }, "imageUrlToken": { "type": "string", "format": "alphanum-64", "description": "A fully qualified URL to an image/icon for the extension." }, "description": { "type": "string", "description": "Optional description of the extension" }, "tags": { "type": "array", "description": "Optional list of tags to find the extension", "items": { "type": "string" } }, "author": { "type": "string", "description": "Author of the extension" }, "extensionType": { "type": "string", "description": "Type of this extension", "enum": [ "nodes" ] }, "nodes": { "type": "object", "properties": { "type": { "type": "string" }, "parentType": { "type": "string", "description": "The type of the node parent, if there is one" }, "defaultLabel": { "type": "string", "description": "The label that should be used when a new Node of this type is created" }, "summary": { "type": "string", "description": "A short line of text that describes what this Node is used for" }, "extension": { "type": "string" }, "extensionImg": { "type": "string" }, "appearance": { "type": "object", "properties": { "logo": { "type": "string" }, "textColor": { "type": "string", "example": "blue", "oneOf": [ { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "color": { "type": "string", "example": "red", "oneOf": [ { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "variant": { "type": "string", "enum": [ "regular", "mini", "hexagon" ] } } }, "behavior": { "type": "object", "properties": { "stopping": { "type": "boolean" }, "entrypoint": { "type": "boolean" } } }, "constraints": { "type": "object", "properties": { "editable": { "type": "boolean", "description": "Should this node be editable" }, "deletable": { "type": "boolean", "description": "Should this node be deletable" }, "creatable": { "type": "boolean", "description": "Should this node be manually creatable" }, "collapsable": { "type": "boolean", "description": "Should this node be collapsable" }, "movable": { "type": "boolean", "description": "Should this node be movable" }, "placement": { "type": "object", "description": "Additional placement information", "properties": { "predecessor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "successor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "children": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } } } } } }, "dependencies": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "string" } } } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule" ] }, "key": { "type": "string" }, "label": { "type": "string" }, "defaultValue": { "description": "The default value for that field" } } } }, "previews": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "message", "image", "code" ] }, "key": { "type": "string" } } } }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 30, "example": "word count" }, "script": { "type": "string", "maxLength": 500, "example": "ci.text.split(' ').length" }, "type": { "type": "string", "enum": [ "profile", "input", "context", "custom", "answer", "flow-output", "flow-input" ], "example": "input" } } } }, "tags": { "type": "string", "enum": [ "basic", "logic", "message", "profile", "service", "nlu", "data" ] }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } }, "connections": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package name of the extension", "example": "azure" }, "type": { "type": "string", "description": "The type of the connection within the extension", "example": "oauth-2" }, "label": { "type": "string", "description": "The label for the connection type", "example": "OAuth-2" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "The name of the field", "example": "client_secret" } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] } } }, "IExtension_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Extension", "example": "New Extension" }, "label": { "type": "string", "description": "The label of the Extension", "example": "New Extension" }, "version": { "type": "string", "description": "The version of the Extension", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$", "example": "1.0.0" }, "imageUrlToken": { "type": "string", "format": "alphanum-64", "description": "A fully qualified URL to an image/icon for the extension." }, "description": { "type": "string", "description": "Optional description of the extension" }, "tags": { "type": "array", "description": "Optional list of tags to find the extension", "items": { "type": "string" } }, "author": { "type": "string", "description": "Author of the extension" }, "extensionType": { "type": "string", "description": "Type of this extension", "enum": [ "nodes" ] }, "nodes": { "type": "object", "properties": { "type": { "type": "string" }, "parentType": { "type": "string", "description": "The type of the node parent, if there is one" }, "defaultLabel": { "type": "string", "description": "The label that should be used when a new Node of this type is created" }, "summary": { "type": "string", "description": "A short line of text that describes what this Node is used for" }, "extension": { "type": "string" }, "extensionImg": { "type": "string" }, "appearance": { "type": "object", "properties": { "logo": { "type": "string" }, "textColor": { "type": "string", "example": "blue", "oneOf": [ { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "color": { "type": "string", "example": "red", "oneOf": [ { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "variant": { "type": "string", "enum": [ "regular", "mini", "hexagon" ] } } }, "behavior": { "type": "object", "properties": { "stopping": { "type": "boolean" }, "entrypoint": { "type": "boolean" } } }, "constraints": { "type": "object", "properties": { "editable": { "type": "boolean", "description": "Should this node be editable" }, "deletable": { "type": "boolean", "description": "Should this node be deletable" }, "creatable": { "type": "boolean", "description": "Should this node be manually creatable" }, "collapsable": { "type": "boolean", "description": "Should this node be collapsable" }, "movable": { "type": "boolean", "description": "Should this node be movable" }, "placement": { "type": "object", "description": "Additional placement information", "properties": { "predecessor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "successor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "children": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } } } } } }, "dependencies": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "string" } } } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule" ] }, "key": { "type": "string" }, "label": { "type": "string" }, "defaultValue": { "description": "The default value for that field" } } } }, "previews": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "message", "image", "code" ] }, "key": { "type": "string" } } } }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 30, "example": "word count" }, "script": { "type": "string", "maxLength": 500, "example": "ci.text.split(' ').length" }, "type": { "type": "string", "enum": [ "profile", "input", "context", "custom", "answer", "flow-output", "flow-input" ], "example": "input" } } } }, "tags": { "type": "string", "enum": [ "basic", "logic", "message", "profile", "service", "nlu", "data" ] }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } }, "connections": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package name of the extension", "example": "azure" }, "type": { "type": "string", "description": "The type of the connection within the extension", "example": "oauth-2" }, "label": { "type": "string", "description": "The label for the connection type", "example": "OAuth-2" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "The name of the field", "example": "client_secret" } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IExtensionIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Extension", "example": "new-extension" }, "label": { "type": "string", "description": "Optional human readable extension name", "example": "New Extension" }, "version": { "type": "string", "description": "The version of the Extension", "example": "1.0.0" }, "imageUrlToken": { "type": "string", "format": "alphanum-64", "description": "A fully qualified URL to an image/icon for the extension." }, "description": { "type": "string", "description": "Optional description of the extension", "example": "This is a fancy extension" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IFileData_2_0": { "type": "object", "properties": { "name": { "type": "string" } } }, "IFile_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IGenericIntentFeedbackFinding_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorFScore", "fairFScore", "goodFScore", "fewSentences", "unclearIntent", "noSiblings" ] } } }, "ILowDataIntentFeedbackFinding_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "IOverlapIntentFeedbackFinding_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "someOverlap", "strongOverlap" ] }, "overlappingIntentReferenceId": { "type": "string" }, "overlappingIntentName": { "type": "string" }, "overlappingIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "overlappingFlowName": { "type": "string" }, "overlappingFlowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IIntentFeedbackReport_2_0": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorFScore", "fairFScore", "goodFScore", "fewSentences", "unclearIntent", "noSiblings" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "someOverlap", "strongOverlap" ] }, "overlappingIntentReferenceId": { "type": "string" }, "overlappingIntentName": { "type": "string" }, "overlappingIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "overlappingFlowName": { "type": "string" }, "overlappingFlowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "ISentenceFeedbackReport_2_0": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "TSentenceFeedbackFindingType_2_0": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] }, "TTrainGroupFeedbackFindingType_2_0": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] }, "ITrainGroupGenericFinding_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, "ITrainGroupLowDataFinding_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "ITrainGroupFeedbackReport_2_0": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "IFlowData_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" } } }, "IFlowGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "intentTrainGroupReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "isTrainingOutOfDate": { "type": "boolean" } } }, "IFlow_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "intentTrainGroupReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "isTrainingOutOfDate": { "type": "boolean" }, "name": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IFlowIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "referenceId": { "type": "string", "format": "uuid" }, "isTrainingOutOfDate": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IIntentData_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "pizza" }, "condition": { "type": "string" }, "rules": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "confirmationSentences": { "type": "array", "items": { "type": "string" } }, "disambiguationSentence": { "type": "string" }, "data": { "type": "object" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "childFeatures": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "example": false }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "analyticsLabel": { "type": "string" } } }, "IIntentGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorFScore", "fairFScore", "goodFScore", "fewSentences", "unclearIntent", "noSiblings" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "someOverlap", "strongOverlap" ] }, "overlappingIntentReferenceId": { "type": "string" }, "overlappingIntentName": { "type": "string" }, "overlappingIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "overlappingFlowName": { "type": "string" }, "overlappingFlowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } } } }, "IIntent_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "pizza" }, "condition": { "type": "string" }, "rules": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "confirmationSentences": { "type": "array", "items": { "type": "string" } }, "disambiguationSentence": { "type": "string" }, "data": { "type": "object" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "childFeatures": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "example": false }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "analyticsLabel": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IIntentIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "referenceId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "pizza" }, "tags": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorFScore", "fairFScore", "goodFScore", "fewSentences", "unclearIntent", "noSiblings" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "someOverlap", "strongOverlap" ] }, "overlappingIntentReferenceId": { "type": "string" }, "overlappingIntentName": { "type": "string" }, "overlappingIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "overlappingFlowName": { "type": "string" }, "overlappingFlowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } } } }, "ILearningSentenceData_2_0": { "type": "object", "properties": { "confirmationCount": { "type": "integer", "example": 42 }, "rejectedCount": { "type": "integer", "example": 42 }, "sentence": { "type": "string", "example": "How do you turn this on?" } } }, "ILearningSentence_2_0": { "type": "object", "properties": { "confirmationCount": { "type": "integer", "example": 42 }, "rejectedCount": { "type": "integer", "example": 42 }, "sentence": { "type": "string", "example": "How do you turn this on?" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ILearningSentenceIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "count": { "type": "integer", "example": 42 }, "sentence": { "type": "string", "example": "How do you turn this on?" } } }, "ISentenceData_2_0": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } } ] } } } }, "ISentenceGeneratedData_2_0": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } } } }, "ISentence_2_0": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "text": { "type": "string", "example": "I want to buy a pizza." }, "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } } ] } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ILexiconSentenceSlot_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, "IAnySlot_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, "ISystemSlot_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, "ISentenceIndexItemData_2_0": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slots": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "tagReference": { "type": "string" }, "lexiconReference": { "type": "string" } } } }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } } } }, "ISentenceIndexItem_2_0": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slots": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "tagReference": { "type": "string" }, "lexiconReference": { "type": "string" } } } }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IFlowSettingsData_2_0": { "type": "object", "properties": { "continueExecutionAfterAttachedFlow": { "type": "boolean" }, "continueExecutionAterDefaultReply": { "type": "boolean" }, "continueExecutionAfterNegativeConfirmation": { "type": "boolean" }, "passDefaultRepliesIntoFlow": { "type": "boolean" }, "flowIntentMappingOrder": { "type": "string", "enum": [ "joint", "main", "attached" ] }, "useAttachedFlowThresholds": { "type": "boolean" }, "useAttachedFlowContinueAfterDefaultReply": { "type": "boolean" }, "useAttachedFlowPassDefaultRepliesIntoFlow": { "type": "boolean" }, "implicitSlotParsing": { "type": "string", "enum": [ "disabled", "full", "system", "lexicon" ] }, "useAttachedFlowImplicitSlotParsing": { "type": "boolean" }, "lexiconSlotsWithSubMatches": { "type": "boolean" } } }, "IFlowSettings_2_0": { "type": "object", "properties": { "continueExecutionAfterAttachedFlow": { "type": "boolean" }, "continueExecutionAterDefaultReply": { "type": "boolean" }, "continueExecutionAfterNegativeConfirmation": { "type": "boolean" }, "passDefaultRepliesIntoFlow": { "type": "boolean" }, "flowIntentMappingOrder": { "type": "string", "enum": [ "joint", "main", "attached" ] }, "useAttachedFlowThresholds": { "type": "boolean" }, "useAttachedFlowContinueAfterDefaultReply": { "type": "boolean" }, "useAttachedFlowPassDefaultRepliesIntoFlow": { "type": "boolean" }, "implicitSlotParsing": { "type": "string", "enum": [ "disabled", "full", "system", "lexicon" ] }, "useAttachedFlowImplicitSlotParsing": { "type": "boolean" }, "lexiconSlotsWithSubMatches": { "type": "boolean" }, "intentThreshold": { "type": "object", "properties": { "lower": { "type": "number", "example": 0.4 }, "upper": { "type": "number", "example": 0.5 } } }, "learnNewExampleSentences": { "type": "boolean" }, "learnNewExampleSentencesThreshold": { "type": "integer" }, "negativeConfirmationWords": { "type": "array", "items": { "type": "string" } }, "positiveConfirmationWords": { "type": "array", "items": { "type": "string" } }, "systemSlots": { "type": "object", "properties": { "useAgeSlots": { "type": "boolean" }, "useDateSlots": { "type": "boolean" }, "useDistanceSlots": { "type": "boolean" }, "useDurationSlots": { "type": "boolean" }, "useEmailSlots": { "type": "boolean" }, "useMoneySlots": { "type": "boolean" }, "useNumberSlots": { "type": "boolean" }, "usePercentageSlots": { "type": "boolean" }, "useTemperatureSlots": { "type": "boolean" }, "useURLSlots": { "type": "boolean" } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ISlotFillerData_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "usePositiveOnly": { "type": "boolean" }, "removeNegated": { "type": "boolean" }, "storeResultInContext": { "type": "boolean" }, "contextKey": { "type": "string" }, "storeInContactProfile": { "type": "boolean" }, "profileKey": { "type": "string" }, "storeDetailedResults": { "type": "boolean" }, "skipIfResultInContext": { "type": "boolean" }, "additionalValidation": { "type": "string" }, "resultLocation": { "type": "string" }, "regex": { "type": "string" }, "slot": { "type": "string" } } }, "ISlotFillerGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" } } }, "ISlotFiller_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "usePositiveOnly": { "type": "boolean" }, "removeNegated": { "type": "boolean" }, "storeResultInContext": { "type": "boolean" }, "contextKey": { "type": "string" }, "storeInContactProfile": { "type": "boolean" }, "profileKey": { "type": "string" }, "storeDetailedResults": { "type": "boolean" }, "skipIfResultInContext": { "type": "boolean" }, "additionalValidation": { "type": "string" }, "resultLocation": { "type": "string" }, "regex": { "type": "string" }, "slot": { "type": "string" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ISlotFillerIndexItemData_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "example": "pizza" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "referenceId": { "type": "string" } } }, "ISlotFillerIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "example": "pizza" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "referenceId": { "type": "string" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IFlowStateData_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "IFlowStateGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" } } }, "IFlowState_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IFlowStateIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "referenceId": { "type": "string", "format": "uuid" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IFunctionData_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "isDisabled": { "type": "boolean" } } }, "IFunction_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "isDisabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IFunctionIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the function", "example": "New Function" }, "code": { "type": "string", "description": "The code of the function", "example": "console.log('Hello World');" }, "referenceId": { "type": "string", "format": "uuid" }, "isDisabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IFunctionInstanceData_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "functionReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "trigger": { "type": "string", "enum": [ "flow", "manual" ], "description": "How was this function instance triggered, e.g. was it spawned while executing a Flow?", "example": "flow" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "error" ], "description": "The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.", "example": "active" }, "error": { "type": "string" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "finishedAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IFunctionInstance_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "functionReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "trigger": { "type": "string", "enum": [ "flow", "manual" ], "description": "How was this function instance triggered, e.g. was it spawned while executing a Flow?", "example": "flow" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "error" ], "description": "The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.", "example": "active" }, "error": { "type": "string" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "finishedAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IFunctionInstanceIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "trigger": { "type": "string", "enum": [ "flow", "manual" ], "description": "How was this function instance triggered, e.g. was it spawned while executing a Flow?", "example": "flow" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "error" ], "description": "The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.", "example": "active" }, "error": { "type": "string" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "finishedAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "TFunctionInstanceStatus_2_0": { "type": "string", "enum": [ "queued", "active", "done", "error" ], "description": "The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.", "example": "active" }, "TFunctionInstanceTrigger_2_0": { "type": "string", "enum": [ "flow", "manual" ], "description": "How was this function instance triggered, e.g. was it spawned while executing a Flow?", "example": "flow" }, "IJourney_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the journey." }, "link": { "type": "string", "description": "A hyperlink to the help-center for this journey." }, "summary": { "type": "string", "description": "A quick summary for what the journey is about." }, "steps": { "type": "object", "properties": { "referenceId": { "type": "string" }, "name": { "type": "string", "description": "The name of this journey step, e.g. 'Create a Virtual Agent'" }, "link": { "type": "string", "description": "A hyperlink to our helpdesk for this journey step." }, "summary": { "type": "string", "description": "A quick summary what this journey step is about." }, "description": { "type": "string", "description": "The full-blown description for this journey step containing rich media." }, "goals": { "type": "array", "items": { "type": "string", "description": "Internal name of the goal." } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IJourneyIndexItem_2_0": { "type": "object", "properties": { "referenceId": { "type": "string" }, "name": { "type": "string", "description": "The name of the journey." }, "link": { "type": "string", "description": "A hyperlink to the help-center for this journey." }, "summary": { "type": "string", "description": "A quick summary for what the journey is about." }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IJourneyProgress_2_0": { "type": "object", "properties": { "userReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "organisationReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "isCurrent": { "type": "boolean", "description": "Information whether this progress object keeps track of the currently selected journey." }, "isComplete": { "type": "boolean", "description": "Information whether the currently selected journey is complete." }, "journeyReferenceId": { "type": "string" }, "journeySteps": { "type": "object", "properties": { "journeyStepReferenceId": { "type": "string" }, "isComplete": { "type": "boolean" }, "completedGoals": { "type": "array", "items": { "type": "string" } } } } } }, "IJourneyStepProgress_2_0": { "type": "object", "properties": { "journeyStepReferenceId": { "type": "string" }, "isComplete": { "type": "boolean" }, "completedGoals": { "type": "array", "items": { "type": "string" } } } }, "IJourneyStep_2_0": { "type": "object", "properties": { "referenceId": { "type": "string" }, "name": { "type": "string", "description": "The name of this journey step, e.g. 'Create a Virtual Agent'" }, "link": { "type": "string", "description": "A hyperlink to our helpdesk for this journey step." }, "summary": { "type": "string", "description": "A quick summary what this journey step is about." }, "description": { "type": "string", "description": "The full-blown description for this journey step containing rich media." }, "goals": { "type": "array", "items": { "type": "string", "description": "Internal name of the goal." } } } }, "IJourneyTrackEventBase_2_0": { "type": "object", "properties": { "event": { "type": "string" }, "payload": { "type": "object" } } }, "IUpdateSelectedJourneyRestDataBody_2_0": { "type": "object", "properties": { "journeyReferenceId": { "type": "string" } } }, "TImportLexiconMode_2_0": { "type": "string", "example": "skip", "enum": [ "skip", "overwrite", "merge" ] }, "ILexiconData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "New Lexicon" } } }, "ILexiconGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "values": { "deprecated": true } } }, "ILexicon_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "New Lexicon" }, "referenceId": { "type": "string", "format": "uuid" }, "values": { "deprecated": true }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ILexiconEntryData_2_0": { "type": "object", "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": {} }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "ILexiconEntryGeneratedData_2_0": { "type": "object", "properties": { "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "keyphrases": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicator if the Keyphrase is the mainKeyphrase", "example": true } } } } }, "ILexiconEntry_2_0": { "type": "object", "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": {} }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "keyphrases": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicator if the Keyphrase is the mainKeyphrase", "example": true } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ILexiconEntryIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "mainKeyphrase": { "description": "the keyphrase value", "example": "pizza" }, "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": {} }, "keyphrases": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicator if the Keyphrase is the mainKeyphrase", "example": true } } }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "ILexiconIndexItemData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "New Lexicon" }, "referenceId": { "type": "string", "format": "uuid" } } }, "ILexiconIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "New Lexicon" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ILexiconKeyphraseData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicates if it is main", "example": true } } }, "ILexiconKeyphrase_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicates if it is main", "example": true }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ILexiconKeyphraseIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the slot", "example": "food" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicates if it is main", "example": true }, "lexiconEntryReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "ILexiconSlotData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" } } }, "ILexiconSlot_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ILexiconSlotIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the slot", "example": "food" } } }, "ILocaleData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "primary": { "type": "boolean" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "ILocale_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "primary": { "type": "boolean" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "ILocaleIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "primary": { "type": "boolean" }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "TNLULanguage_2_0": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "INLUConnectorData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "twilioAutopilotBuiltIn", "luis", "watson", "noNlu", "cognigy", "code" ] }, "settings": { "oneOf": [ { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } } ] }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } } } }, "INLUConnectorGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" } } }, "INLUConnector_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "twilioAutopilotBuiltIn", "luis", "watson", "noNlu", "cognigy", "code" ] }, "settings": { "oneOf": [ { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } } ] }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "INLUTransformerFunction_2_0": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } }, "IDialogFlowSettings_2_0": { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, "ILuisSettings_2_0": { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, "IWatsonSettings_2_0": { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } }, "IAlexaSettings_2_0": { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, "ISkill_2_0": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } }, "INLUConnectorIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "referenceId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "twilioAutopilotBuiltIn", "luis", "watson", "noNlu", "cognigy", "code" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "TNLUConnectorType_2_0": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "twilioAutopilotBuiltIn", "luis", "watson", "noNlu", "cognigy", "code" ] }, "INodeDescriptor_2_0": { "type": "object", "properties": { "type": { "type": "string" }, "parentType": { "type": "string", "description": "The type of the node parent, if there is one" }, "defaultLabel": { "type": "string", "description": "The label that should be used when a new Node of this type is created" }, "summary": { "type": "string", "description": "A short line of text that describes what this Node is used for" }, "extension": { "type": "string" }, "extensionImg": { "type": "string" }, "appearance": { "type": "object", "properties": { "logo": { "type": "string" }, "textColor": { "type": "string", "example": "blue", "oneOf": [ { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "color": { "type": "string", "example": "red", "oneOf": [ { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "variant": { "type": "string", "enum": [ "regular", "mini", "hexagon" ] } } }, "behavior": { "type": "object", "properties": { "stopping": { "type": "boolean" }, "entrypoint": { "type": "boolean" } } }, "constraints": { "type": "object", "properties": { "editable": { "type": "boolean", "description": "Should this node be editable" }, "deletable": { "type": "boolean", "description": "Should this node be deletable" }, "creatable": { "type": "boolean", "description": "Should this node be manually creatable" }, "collapsable": { "type": "boolean", "description": "Should this node be collapsable" }, "movable": { "type": "boolean", "description": "Should this node be movable" }, "placement": { "type": "object", "description": "Additional placement information", "properties": { "predecessor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "successor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "children": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } } } } } }, "dependencies": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "string" } } } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule" ] }, "key": { "type": "string" }, "label": { "type": "string" }, "defaultValue": { "description": "The default value for that field" } } } }, "previews": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "message", "image", "code" ] }, "key": { "type": "string" } } } }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 30, "example": "word count" }, "script": { "type": "string", "maxLength": 500, "example": "ci.text.split(' ').length" }, "type": { "type": "string", "enum": [ "profile", "input", "context", "custom", "answer", "flow-output", "flow-input" ], "example": "input" } } } }, "tags": { "type": "string", "enum": [ "basic", "logic", "message", "profile", "service", "nlu", "data" ] }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } }, "INodeFieldCondition_2_0": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } }, "INodeSection_2_0": { "type": "object", "properties": { "key": { "type": "string", "description": "Unique identifier for this section within all sections of a descriptor, e.g. 'authentication" }, "label": { "type": "string", "description": "Condition whether this section should be rendered" }, "condition": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } }, "defaultCollapsed": { "type": "boolean", "description": "Whether the sections should be collapsed by default", "default": false }, "fields": { "type": "array", "items": { "type": "string" } } } }, "INodeFieldAndSectionFormElement_2_0": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } }, "IOptionsResolverRestReturnValue_2_0": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } } } } } }, "IPackageData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Package", "example": "New Package" }, "description": { "type": "string", "description": "The description of the Package", "example": "Version 1" } } }, "IPackageGeneratedData_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "hash": { "type": "string", "description": "The hash identifying the contents of the Package", "example": "Version 1" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IPackageDataCreate_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Package", "example": "New Package" }, "description": { "type": "string", "description": "The description of the Package", "example": "Version 1" }, "resourceIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "IPackage_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Package", "example": "New Package" }, "description": { "type": "string", "description": "The description of the Package", "example": "Version 1" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "hash": { "type": "string", "description": "The hash identifying the contents of the Package", "example": "Version 1" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IPackageIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Package", "example": "New Package" }, "description": { "type": "string", "description": "The description of the Package", "example": "Version 1" }, "hash": { "type": "string", "description": "The hash of the Package identifying the contents of the Package" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IStrategy_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rename": { "type": "string", "description": "explicitly sets a new name for the imported resource", "example": "new flow" }, "autoRename": { "type": "boolean", "description": "If set to true, will append a \"counter-suffix\" to the name in\ncase the name already exists in the agent.\n", "default": true, "example": true }, "identityConflictStrategy": { "type": "string", "description": "Defines what should be done in case the agent already contains a resource\nwith the same id.\n", "default": "abort", "enum": [ "replace", "re-identify", "abort" ] } } }, "IPlaybookData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Playbook", "example": "New Playbook" }, "abortOnError": { "type": "boolean", "description": "Flag wheter to stop Playbook execution when an assert-error occured" }, "timeout": { "type": "integer", "description": "A time (in ms) after which a playbook step is 'invalid/failed'", "example": 2000, "minimum": 1 } } }, "IPlaybook_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Playbook", "example": "New Playbook" }, "abortOnError": { "type": "boolean", "description": "Flag wheter to stop Playbook execution when an assert-error occured" }, "timeout": { "type": "integer", "description": "A time (in ms) after which a playbook step is 'invalid/failed'", "example": 2000, "minimum": 1 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "string", "description": "The data of this playbook step", "example": {} }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "asserts": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "string", "description": "The data of this playbook step", "example": {} }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IPlaybookIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the playbook", "example": "New Playbook" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IPlaybookStepData_2_0": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "string", "description": "The data of this playbook step", "example": {} } } }, "IPlaybookStep_2_0": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "string", "description": "The data of this playbook step", "example": {} }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "asserts": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "string", "description": "The data of this playbook step", "example": {} }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "IPlaybookStepAssertData_2_0": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the Assert", "enum": [ "assertText", "assertData", "assertState", "assertContext", "assertIntent", "assertSlot" ] }, "params": { "type": "object" } } }, "IPlaybookStepAssert_2_0": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "string", "description": "The data of this playbook step", "example": {} }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "ICreateProjectByTemplateRestDataBody_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "locale": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "templateConfiguration": { "type": "object", "properties": { "endpoints": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string" } } } }, "skills": { "type": "array", "items": { "type": "string" } }, "template": { "type": "string" } } } } }, "IGraph_2_0": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "example": "project", "enum": [ "project", "snapshot" ] }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "resources": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "properties": { "type": "object" } } } } } } ] } }, "IGraphProject_2_0": { "type": "object", "properties": { "type": { "type": "string", "example": "project", "enum": [ "project", "snapshot" ] }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "resources": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "properties": { "type": "object" } } } } } }, "IGraphResource_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "properties": { "type": "object" } } }, "IProjectData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] } } }, "IProjectGeneratedData_2_0": { "type": "object", "properties": { "primaryLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IProjectCreateData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "locale": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] } } }, "IProject_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "primaryLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IProjectIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "IAgentSettingsData_2_0": { "type": "object", "properties": { "timezone": { "type": "string", "description": "Timezone according to IANA Timezone Database (2020a)", "example": "Europe/Berlin", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Pacific-New", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu" ] }, "useCaseSensitiveIntentMapping": { "type": "boolean" }, "collectAnalytics": { "type": "boolean" }, "trackDataOnlyInputs": { "type": "boolean" }, "translationSettings": { "type": "object", "properties": { "translationProvider": { "type": "string", "description": "Supported Translation Providers", "enum": [ "none", "microsoft", "google", "deepl" ] }, "translationAPIKey": { "type": "string", "maxLength": 30, "description": "Translation Provider API Key" }, "translationRetries": { "type": "integer", "minimum": 0, "maximum": 3, "description": "How often to retry calling the translation provider if an error occurs" }, "translationTimeout": { "type": "integer", "minimum": 0, "maximum": 8000, "description": "How long to wait for the provider to answer a request (in milliseconds)" }, "translationCacheExpiry": { "type": "integer", "enum": [ 0, 3600, 8000 ], "description": "How long to keep translated sentences in the cache (in seconds)" } } } } }, "IAgentSettings_2_0": { "type": "object", "properties": { "timezone": { "type": "string", "description": "Timezone according to IANA Timezone Database (2020a)", "example": "Europe/Berlin", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Pacific-New", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu" ] }, "useCaseSensitiveIntentMapping": { "type": "boolean" }, "collectAnalytics": { "type": "boolean" }, "trackDataOnlyInputs": { "type": "boolean" }, "translationSettings": { "type": "object", "properties": { "translationProvider": { "type": "string", "description": "Supported Translation Providers", "enum": [ "none", "microsoft", "google", "deepl" ] }, "translationAPIKey": { "type": "string", "maxLength": 30, "description": "Translation Provider API Key" }, "translationRetries": { "type": "integer", "minimum": 0, "maximum": 3, "description": "How often to retry calling the translation provider if an error occurs" }, "translationTimeout": { "type": "integer", "minimum": 0, "maximum": 8000, "description": "How long to wait for the provider to answer a request (in milliseconds)" }, "translationCacheExpiry": { "type": "integer", "enum": [ 0, 3600, 8000 ], "description": "How long to keep translated sentences in the cache (in seconds)" } } }, "intentThreshold": { "type": "object", "properties": { "lower": { "type": "number", "example": 0.4 }, "upper": { "type": "number", "example": 0.5 } } }, "learnNewExampleSentences": { "type": "boolean" }, "learnNewExampleSentencesThreshold": { "type": "integer" }, "negativeConfirmationWords": { "type": "array", "items": { "type": "string" } }, "positiveConfirmationWords": { "type": "array", "items": { "type": "string" } }, "systemSlots": { "type": "object", "properties": { "useAgeSlots": { "type": "boolean" }, "useDateSlots": { "type": "boolean" }, "useDistanceSlots": { "type": "boolean" }, "useDurationSlots": { "type": "boolean" }, "useEmailSlots": { "type": "boolean" }, "useMoneySlots": { "type": "boolean" }, "useNumberSlots": { "type": "boolean" }, "usePercentageSlots": { "type": "boolean" }, "useTemperatureSlots": { "type": "boolean" }, "useURLSlots": { "type": "boolean" } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] }, "TTranslationProvider_2_0": { "type": "string", "description": "Supported Translation Providers", "enum": [ "none", "microsoft", "google", "deepl" ] }, "IAgentTranslationSettings_2_0": { "type": "object", "properties": { "translationProvider": { "type": "string", "description": "Supported Translation Providers", "enum": [ "none", "microsoft", "google", "deepl" ] }, "translationAPIKey": { "type": "string", "maxLength": 30, "description": "Translation Provider API Key" }, "translationRetries": { "type": "integer", "minimum": 0, "maximum": 3, "description": "How often to retry calling the translation provider if an error occurs" }, "translationTimeout": { "type": "integer", "minimum": 0, "maximum": 8000, "description": "How long to wait for the provider to answer a request (in milliseconds)" }, "translationCacheExpiry": { "type": "integer", "enum": [ 0, 3600, 8000 ], "description": "How long to keep translated sentences in the cache (in seconds)" } } }, "ISharedSettings_2_0": { "type": "object", "properties": { "intentThreshold": { "type": "object", "properties": { "lower": { "type": "number", "example": 0.4 }, "upper": { "type": "number", "example": 0.5 } } }, "learnNewExampleSentences": { "type": "boolean" }, "learnNewExampleSentencesThreshold": { "type": "integer" }, "negativeConfirmationWords": { "type": "array", "items": { "type": "string" } }, "positiveConfirmationWords": { "type": "array", "items": { "type": "string" } }, "systemSlots": { "type": "object", "properties": { "useAgeSlots": { "type": "boolean" }, "useDateSlots": { "type": "boolean" }, "useDistanceSlots": { "type": "boolean" }, "useDurationSlots": { "type": "boolean" }, "useEmailSlots": { "type": "boolean" }, "useMoneySlots": { "type": "boolean" }, "useNumberSlots": { "type": "boolean" }, "usePercentageSlots": { "type": "boolean" }, "useTemperatureSlots": { "type": "boolean" }, "useURLSlots": { "type": "boolean" } } } } }, "ISnippet_2_0": { "type": "object", "properties": { "label": { "type": "string", "description": "The snippet Name", "example": "New snippet" } } }, "ISearchResultIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "pizza-endpoint" }, "type": { "type": "string", "description": "The type of a resource", "example": "endpoint", "enum": [ "endpoint", "extension", "flow", "function", "lexicon", "nluconnector", "playbook", "project", "snapshot" ] }, "subType": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "twilioAutopilotBuiltIn", "luis", "watson", "noNlu", "cognigy", "code" ] }, { "type": "string", "example": "webchat2", "enum": [ "facebook", "alexa", "slack", "google", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat", "webchat2", "dialogflow", "twilio", "twilio-sms", "twilio-autopilot", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya" ] } ] }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IResourceInSnapshotItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "New Resource" }, "referenceId": { "type": "string", "description": "The reference ID of the resource" }, "resourceType": { "type": "string", "description": "The type of resource", "example": "flow" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 } } }, "ISnapshotData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Snapshot", "example": "New Snapshot" }, "description": { "type": "string", "description": "The description of the Snapshot", "example": "Version 1" } } }, "ISnapshotGeneratedData_2_0": { "type": "object", "properties": { "isPackaged": { "type": "boolean", "description": "Whether the Snapshot has already been packaged and is ready for download" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "hash": { "type": "string", "description": "The hash identifying the contents of the Snapshot", "example": "Version 1" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "ISnapshot_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Snapshot", "example": "New Snapshot" }, "description": { "type": "string", "description": "The description of the Snapshot", "example": "Version 1" }, "isPackaged": { "type": "boolean", "description": "Whether the Snapshot has already been packaged and is ready for download" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "hash": { "type": "string", "description": "The hash identifying the contents of the Snapshot", "example": "Version 1" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "ISnapshotIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Snapshot", "example": "New Snapshot" }, "description": { "type": "string", "description": "The description of the Snapshot", "example": "Version 1" }, "isPackaged": { "type": "boolean", "description": "Whether the Snapshot has already been packaged and is ready for download" }, "packageExpiresAt": { "type": "number", "description": "The timestamp where the downloadable package expires" }, "hash": { "type": "string", "description": "The hash of the Snapshot identifying the contents of the Snapshot" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 } } }, "ICrudPermissions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "IOrganisationWideAcl": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "livechat": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } } } }, "IProjectWideAcl": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "analytics": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "livechat": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "additionalProperties": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "intents", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor" ] } }, "allowedLocales": { "type": "array", "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "primary": { "type": "boolean" } } } } } }, "IUserAcl": { "type": "object", "properties": { "organisationWide": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "livechat": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } } } }, "projectWide": { "type": "object", "additionalProperties": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "analytics": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "livechat": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "additionalProperties": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "intents", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor" ] } }, "allowedLocales": { "type": "array", "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "primary": { "type": "boolean" } } } } } } } } }, "IAllowedLocale": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "primary": { "type": "boolean" } } }, "TIdentityProviderType": { "type": "string", "description": "The Type of Identity Provider. Currently saml and oidc are supported.\n", "enum": [ "saml", "oidc" ] }, "ISamlIdentityProviderData": { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "saml" ] }, "idpIssuer": { "type": "string", "description": "The value that will be in the issuer field in the SAML request.", "format": "url" }, "idpLoginEndpoint": { "type": "string", "description": "The URL to use to login in the IDP. Used in the SP initiated Flow.", "format": "url" }, "idpLogoutEndpoint": { "type": "string", "description": "The URL to send SLO requests against. Not all identity providers support this.", "format": "url" }, "idpCertificate": { "type": "string", "description": "The certificate from the ID used to sign the SAML requests. It is base64 encoded." }, "decryptionPrivateKey": { "type": "string", "description": "An optional decryption key. This is necessary if the SAML request is encoded." }, "idpDisableRequestedAuthnContext": { "type": "boolean", "description": "For some providers, e.g. Azure on-prem, it might be necessary to disable the authn context field in the SAML request.", "default": false } } }, "TIdpTokenEndpointAuthMethod": { "type": "string", "description": "Requested Client Authentication method for the Token Endpoint.\n\nhttps://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication\n", "enum": [ "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt", "tls_client_auth", "self_signed_tls_client_auth", "none" ], "default": "client_secret_basic", "example": "client_secret_basic" }, "TIdpIdTokenSignedResponseAlg": { "type": "string", "description": "The Algorithm used to sign the ID Token issued to this Client.\n", "enum": [ "RS256", "RS384", "RS512", "HS256", "HS384", "HS512" ], "default": "RS256", "example": "RS256" }, "IOidcIdentityProviderData": { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "oidc" ] }, "idpIssuer": { "type": "string", "description": "The openId-Connect baseUrl", "format": "url" }, "idpClientId": { "type": "string", "description": "The client identifier issued to the client during\nthe registration process.\n\nThe authorization server issues the registered client a client\nidentifier -- a unique string representing the registration\ninformation provided by the client. The client identifier is not\na secret; it is exposed to the resource owner and MUST NOT be\nused alone for client authentication.\n\nThe client identifier is unique to the authorization server.\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\n" }, "idpClientSecret": { "type": "string", "description": "This value is used by Confidential Clients to authenticate to the\nToken Endpoint, as described in Section 2.3.1 of OAuth 2.0, and\nfor the derivation of symmetric encryption key values, as\ndescribed in Section 10.2 of OpenID Connect Core 1.0\n[OpenID.Core].\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\nhttps://openid.net/specs/openid-connect-core-1_0.html#Encryption\n" }, "idpAdditionalScope": { "type": "string", "default": "openid profile email offline_access", "description": "The scopes associated with Access Tokens determine what resources\nwill be available when they are used to access OAuth 2.0\nprotected endpoints.\nFor OpenID Connect, scopes can be used to request that specific\nsets of information be made available as Claim Values.\nThe scopes openid, profile, email and offline_access are always\nrequested.\n" }, "idpFrontChannelUrl": { "type": "string", "format": "url" }, "idpIdTokenSignedResponseAlg": { "type": "string", "description": "The Algorithm used to sign the ID Token issued to this Client.\n", "enum": [ "RS256", "RS384", "RS512", "HS256", "HS384", "HS512" ], "default": "RS256", "example": "RS256" }, "idpTokenEndpointAuthMethod": { "type": "string", "description": "Requested Client Authentication method for the Token Endpoint.\n\nhttps://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication\n", "enum": [ "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt", "tls_client_auth", "self_signed_tls_client_auth", "none" ], "default": "client_secret_basic", "example": "client_secret_basic" } } }, "IIdentityProviderData": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "saml" ] }, "idpIssuer": { "type": "string", "description": "The value that will be in the issuer field in the SAML request.", "format": "url" }, "idpLoginEndpoint": { "type": "string", "description": "The URL to use to login in the IDP. Used in the SP initiated Flow.", "format": "url" }, "idpLogoutEndpoint": { "type": "string", "description": "The URL to send SLO requests against. Not all identity providers support this.", "format": "url" }, "idpCertificate": { "type": "string", "description": "The certificate from the ID used to sign the SAML requests. It is base64 encoded." }, "decryptionPrivateKey": { "type": "string", "description": "An optional decryption key. This is necessary if the SAML request is encoded." }, "idpDisableRequestedAuthnContext": { "type": "boolean", "description": "For some providers, e.g. Azure on-prem, it might be necessary to disable the authn context field in the SAML request.", "default": false } } }, { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "oidc" ] }, "idpIssuer": { "type": "string", "description": "The openId-Connect baseUrl", "format": "url" }, "idpClientId": { "type": "string", "description": "The client identifier issued to the client during\nthe registration process.\n\nThe authorization server issues the registered client a client\nidentifier -- a unique string representing the registration\ninformation provided by the client. The client identifier is not\na secret; it is exposed to the resource owner and MUST NOT be\nused alone for client authentication.\n\nThe client identifier is unique to the authorization server.\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\n" }, "idpClientSecret": { "type": "string", "description": "This value is used by Confidential Clients to authenticate to the\nToken Endpoint, as described in Section 2.3.1 of OAuth 2.0, and\nfor the derivation of symmetric encryption key values, as\ndescribed in Section 10.2 of OpenID Connect Core 1.0\n[OpenID.Core].\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\nhttps://openid.net/specs/openid-connect-core-1_0.html#Encryption\n" }, "idpAdditionalScope": { "type": "string", "default": "openid profile email offline_access", "description": "The scopes associated with Access Tokens determine what resources\nwill be available when they are used to access OAuth 2.0\nprotected endpoints.\nFor OpenID Connect, scopes can be used to request that specific\nsets of information be made available as Claim Values.\nThe scopes openid, profile, email and offline_access are always\nrequested.\n" }, "idpFrontChannelUrl": { "type": "string", "format": "url" }, "idpIdTokenSignedResponseAlg": { "type": "string", "description": "The Algorithm used to sign the ID Token issued to this Client.\n", "enum": [ "RS256", "RS384", "RS512", "HS256", "HS384", "HS512" ], "default": "RS256", "example": "RS256" }, "idpTokenEndpointAuthMethod": { "type": "string", "description": "Requested Client Authentication method for the Token Endpoint.\n\nhttps://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication\n", "enum": [ "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt", "tls_client_auth", "self_signed_tls_client_auth", "none" ], "default": "client_secret_basic", "example": "client_secret_basic" } } } ] }, "TOrganisationWidePermissions": { "type": "string", "enum": [ "analyticsOdata", "apiKeys", "livechat", "projects", "userDetails", "users" ] }, "TProjectWidePermissions": { "type": "string", "enum": [ "analytics", "connections", "contactProfiles", "conversationHistory", "endpoints", "extensions", "flowNodeComments", "flowNodeDescription", "flowNodes", "flows", "intents", "lexicons", "locales", "logs", "memberDetails", "members", "nluConnectors", "packages", "playbooks", "project", "projectSettings", "snapshots", "states", "tasks", "tokens", "functions" ] }, "TPermissionState": { "type": "number", "enum": [ -1, 0, 1 ], "description": "Sort order:\n * `-1` - explicitly denied\n * `0` - unset(inherit)\n * `1` - explicitly granted\n" }, "IProjectScope": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "TOrganisationWideRole": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] }, "TProjectWideRole": { "type": "string", "enum": [ "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "intents", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor" ] }, "TTaskProgress": { "type": "integer", "minimum": 0, "maximum": 100 }, "TCognigyColorName": { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] }, "TCSSColorHex": { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ff8a80" }, "TCSSColor": { "oneOf": [ { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ff8a80" }, { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] } ] }, "TCSSColorName": { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, "TMongoId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "TTimestamp": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "TTimezone": { "type": "string", "description": "Timezone according to IANA Timezone Database (2020a)", "example": "Europe/Berlin", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Pacific-New", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu" ] }, "ICursorBasedPaginationReturnValue": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "total": { "type": "integer", "example": 1 }, "next": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": "5ce7c2d833ea1e04d7e6c432" }, "previous": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": null } } } }, "responses": { "BadGatewayError": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "BadRequestError": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "ConflictError": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "ForbiddenError": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "GatewayTimeoutError": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "InternalServerError": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "MethodNotAllowedError": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "NotImplementedError": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "PayloadTooLargeError": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "PaymentRequiredError": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "NotFoundError": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "ServiceUnavailableError": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "UnauthorizedError": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } } }, "security": [ { "APIKeyHeader": [] }, { "APIKeyQueryParam": [] }, { "OAuth2": [] }, { "BasicAuth": [] } ], "externalDocs": { "description": "Cognigy.AI Documentation", "url": "https://docs.cognigy.com/docs/" }, "tags": [ { "name": "Cognigy.AI REST-ful API", "description": "The Cognigy.AI REST-ful API" } ], "openapi": "3.0.0", "paths": { "/.well-known/webfinger": { "get": { "operationId": "webfinger", "description": "Webfinger-Endpoint", "tags": [ "Webfinger" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "resource", "required": true, "schema": { "type": "string", "format": "uri" } }, { "in": "query", "name": "rel", "schema": { "type": "array", "items": { "type": "array", "items": { "type": "string", "enum": [ "idp" ] } } } } ], "responses": { "200": { "description": "Returns the Webfinger result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string", "example": "org:5ce7c2d833ea1e04d7e6c432" }, "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string", "enum": [ "idp" ] }, "properties": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } } ] } } } } } } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/auditevents": { "get": { "operationId": "indexAuditEvents_2_0", "summary": "Get all audit events", "description": "Get all [Audit Event](doc:auditevents) objects metadata in the system.", "tags": [ "AuditEvents v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns array of audit event metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp when the action happened", "example": "2020-04-27T14:22:11.000Z" }, "type": { "type": "string", "description": "The type of operation that was performed", "example": "create", "enum": [ "action", "create", "replace", "patch", "delete", "unauthorized" ] }, "user": { "type": "string", "description": "The email of the user who performed the operation", "example": "hans.mustermann@xyz.com" }, "modifiedResources": { "type": "array", "description": "A list of resources in the chain of the modification", "items": { "type": "object", "properties": { "elementId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "elementType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "user", "trainerRecord" ] } } } } } } }, "total": { "type": "integer", "example": 1 }, "next": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": "5ce7c2d833ea1e04d7e6c432" }, "previous": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": null } } } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/auditevents/{auditEventId}": { "get": { "operationId": "readAuditEvent_2_0", "summary": "Get an audit event", "description": "Get a single [Audit event](doc:auditevent) object in the system.", "tags": [ "AuditEvents v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "auditEventId", "schema": { "type": "string" }, "required": true, "description": "Audit event ID" } ], "responses": { "200": { "description": "Returns audit event object", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "description": "The timestamp when the action happened", "example": "2020-04-27T14:22:11.000Z" }, "type": { "type": "string", "description": "The type of operation that was performed", "example": "create", "enum": [ "action", "create", "replace", "patch", "delete", "unauthorized" ] }, "user": { "type": "string", "description": "The email of the user who performed the operation", "example": "hans.mustermann@xyz.com" }, "modifiedResources": { "type": "array", "description": "An list of resources in the chain of the modification", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "description": "The id of the resource in the modification chain", "example": "5e997f0cdcfc57730cf32941" }, "resourceType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "user", "trainerRecord" ] } } } }, "payload": { "type": "object", "description": "The raw payload of the operation in case it was tracked", "example": { "name": "new resource name" } } } } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/identityprovider/configure": { "post": { "operationId": "configureIdentityProvider_2_0", "summary": "Configure an identity provider for your organisation.", "description": "Configure an identity provider for your organisation.", "tags": [ "IdentityProviders v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "saml" ] }, "idpIssuer": { "type": "string", "description": "The value that will be in the issuer field in the SAML request.", "format": "url" }, "idpLoginEndpoint": { "type": "string", "description": "The URL to use to login in the IDP. Used in the SP initiated Flow.", "format": "url" }, "idpLogoutEndpoint": { "type": "string", "description": "The URL to send SLO requests against. Not all identity providers support this.", "format": "url" }, "idpCertificate": { "type": "string", "description": "The certificate from the ID used to sign the SAML requests. It is base64 encoded." }, "decryptionPrivateKey": { "type": "string", "description": "An optional decryption key. This is necessary if the SAML request is encoded." }, "idpDisableRequestedAuthnContext": { "type": "boolean", "description": "For some providers, e.g. Azure on-prem, it might be necessary to disable the authn context field in the SAML request.", "default": false } } }, { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "oidc" ] }, "idpIssuer": { "type": "string", "description": "The openId-Connect baseUrl", "format": "url" }, "idpClientId": { "type": "string", "description": "The client identifier issued to the client during\nthe registration process.\n\nThe authorization server issues the registered client a client\nidentifier -- a unique string representing the registration\ninformation provided by the client. The client identifier is not\na secret; it is exposed to the resource owner and MUST NOT be\nused alone for client authentication.\n\nThe client identifier is unique to the authorization server.\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\n" }, "idpClientSecret": { "type": "string", "description": "This value is used by Confidential Clients to authenticate to the\nToken Endpoint, as described in Section 2.3.1 of OAuth 2.0, and\nfor the derivation of symmetric encryption key values, as\ndescribed in Section 10.2 of OpenID Connect Core 1.0\n[OpenID.Core].\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\nhttps://openid.net/specs/openid-connect-core-1_0.html#Encryption\n" }, "idpAdditionalScope": { "type": "string", "default": "openid profile email offline_access", "description": "The scopes associated with Access Tokens determine what resources\nwill be available when they are used to access OAuth 2.0\nprotected endpoints.\nFor OpenID Connect, scopes can be used to request that specific\nsets of information be made available as Claim Values.\nThe scopes openid, profile, email and offline_access are always\nrequested.\n" }, "idpFrontChannelUrl": { "type": "string", "format": "url" }, "idpIdTokenSignedResponseAlg": { "type": "string", "description": "The Algorithm used to sign the ID Token issued to this Client.\n", "enum": [ "RS256", "RS384", "RS512", "HS256", "HS384", "HS512" ], "default": "RS256", "example": "RS256" }, "idpTokenEndpointAuthMethod": { "type": "string", "description": "Requested Client Authentication method for the Token Endpoint.\n\nhttps://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication\n", "enum": [ "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt", "tls_client_auth", "self_signed_tls_client_auth", "none" ], "default": "client_secret_basic", "example": "client_secret_basic" } } } ] } } } }, "responses": { "204": { "description": "The identity provider was configured for your organisation." }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/identityprovider/reset": { "post": { "operationId": "resetIdentityProvider_2_0", "summary": "Resets the identity configruation.", "description": "Resets the identity configuration for the current organisation by removing it.", "tags": [ "IdentityProviders v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "204": { "description": "The identity provider configuration was successfully reset." }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/system/license": { "get": { "operationId": "getSystemLicenseState_2_0", "summary": "Get the license state", "description": "Retrieves the current system license state. Used within e.g. the UI to display certain license warnings.", "tags": [ "Administration v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "The state of the license", "content": { "application/json": { "schema": { "type": "object", "properties": { "state": { "type": "string", "description": "The state of the license", "example": "valid", "enum": [ "invalid", "valid", "willExpireSoon", "expiredRenewRequired", "expired" ] } } } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] }, "post": { "operationId": "setSystemLicense_2_0", "summary": "Set the license", "description": "Set the system license of your platform installation.", "tags": [ "Administration v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string" }, "licensekey": { "type": "string" } } } } } }, "responses": { "202": { "description": "Successfully updated the System License", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "The success message.", "example": "The new license was installed within the system." } } } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/system/message": { "get": { "operationId": "getSystemMessage_2_0", "summary": "Get potential system wide maintenance messages", "tags": [ "Administration v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "The maintenance message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Next great Update will be released next Monday." }, "until": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } } } } }, "204": { "description": "Currently no maintenance message" }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users/me/accepttermsofservice": { "post": { "operationId": "acceptTermsOfService_2_0", "summary": "Accept the Terms of Service", "description": "The User accepts the Terms of Service.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "204": { "description": "Successfully accepted the Terms of Services" }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/projects/{projectId}/addprojectmember": { "post": { "operationId": "addProjectMember_2_0", "summary": "Adds a new project member.", "description": "Adds a new already existing user to this project as a member.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "Project member was added." }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users/{userId}/addproject": { "post": { "operationId": "addProjectToUser_2_0", "summary": "Makes a project available to a user.", "description": "Gives an user access to a project.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "The project is now accessible for the user." }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/projects/{projectId}/members/{userId}/addroletomember": { "post": { "operationId": "addRoleToMember_2_0", "summary": "Adds a new project-wide role to a user.", "description": "Adds a new project-wide role to an already existing user.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "intents", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor" ] } } } } } }, "responses": { "204": { "description": "User-role was added to the project member." }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users/{userId}/addroletouser": { "post": { "operationId": "addRoleToUser_2_0", "summary": "Adds a new org-wide role to an user.", "description": "Adds a new organisation wide user-role to an user.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } } } } } }, "responses": { "204": { "description": "User-role was added to the user." }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users/me/apikeys": { "post": { "operationId": "createApiKeyMe_2_0", "summary": "Creates a new api-key for the own user.", "description": "Creates a new [ApiKey](doc:apikeys) for the own user.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the ApiKey", "example": "Office" } } } } } }, "responses": { "201": { "description": "Returns the created api-key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 }, "apiKey": { "type": "string" } } } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] }, "get": { "operationId": "indexApiKeysMe_2_0", "summary": "Get all api-keys of the current user.", "description": "Get all api-keys of the current user.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns api-keys of the current user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "apiKey": { "type": "string" }, "createdAt": { "type": "number" } } } }, "total": { "type": "integer", "example": 1 }, "next": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": "5ce7c2d833ea1e04d7e6c432" }, "previous": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": null } } } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users": { "post": { "operationId": "createUser_2_0", "summary": "Creates a new user", "description": "Creates a new [User](doc:users) in the system.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "password": { "type": "string", "description": "Enter password in case of non-sso user" } } } } } }, "responses": { "201": { "description": "Returns the created user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] }, "get": { "operationId": "indexUsers_2_0", "summary": "Get all users", "description": "Get metadata for all [Users](doc:users) within the system.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns metadata objects for each user in the system.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] } }, "total": { "type": "integer", "example": 1 }, "next": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": "5ce7c2d833ea1e04d7e6c432" }, "previous": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": null } } } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users/me/apikeys/{apiKeyId}": { "delete": { "operationId": "deleteApiKeyMe_2_0", "summary": "Deletes an api-key for the own user.", "description": "Deletes an [ApiKey](doc:apikeys) for the own user.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "apiKeyId", "description": "The Id of an Api Key", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The Api key was removed" }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users/{userId}": { "delete": { "operationId": "deleteUser_2_0", "summary": "Deletes an user.", "description": "Deletes a [User](doc:users) from the system completely.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The user was removed successfully." }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] }, "get": { "operationId": "readUser_2_0", "summary": "Get a user", "description": "Get full data of a [User](doc:users) from the system.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns User object", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] }, "patch": { "operationId": "updateUser_2_0", "summary": "Updates a user.", "description": "Updates the profile of a [User](doc:users).", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "newPassword": { "type": "string" } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] } } } }, "responses": { "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users/me": { "delete": { "operationId": "deleteUserMe_2_0", "summary": "Deletes the own user.", "description": "Deletes the own [User](doc:users) from the system completely.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "204": { "description": "The own user was removed successfully." }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] }, "get": { "operationId": "readUserMe_2_0", "summary": "Gets own user profile.", "description": "Gets the users own [User](doc:users) profile.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "Returns own User object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] }, "patch": { "operationId": "updateUserMe_2_0", "summary": "Updates the own user object.", "description": "Updates the profile of the own [User](doc:users).", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "livechat", "odata", "projectManager", "userManager" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "newPassword": { "type": "string" } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] } } } }, "responses": { "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users/deprecatepassword": { "post": { "operationId": "deprecatePassword_2_0", "summary": "Deprecates a user-password / all passwords in the org.", "description": "Deprecates the password of a single user or all users of the organisation.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "The password(s) was/were deprecated." }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users/me/loginattempts": { "get": { "operationId": "indexLoginAttemptsMe_2_0", "summary": "Get all login attempts of the own user.", "description": "Get all login attempt objects for the current user.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns login attempt objects for the curren tuser.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "failed" ] }, "timestamp": { "type": "number" }, "location": { "type": "string" } } } }, "total": { "type": "integer", "example": 1 }, "next": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": "5ce7c2d833ea1e04d7e6c432" }, "previous": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": null } } } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/projects/{projectId}/members": { "get": { "operationId": "indexProjectMembers_2_0", "summary": "Get all members of a project", "description": "Get metadata for all [Members](doc:members) of a project.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns metadata objects for each project member.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] } }, "total": { "type": "integer", "example": 1 }, "next": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": "5ce7c2d833ea1e04d7e6c432" }, "previous": { "oneOf": [ { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, { "nullable": true } ], "example": null } } } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users/{userId}/logout": { "post": { "operationId": "logoutUser_2_0", "summary": "Performs a logout for a specific user.", "description": "Performs a logout for a specific user and removes access-/refresh-token pair.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The session was successfully destroyed." }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/users/me/lastloginattempt": { "post": { "operationId": "readLastLoginAttemptMe_2_0", "summary": "Retrieves the last login attempt.", "description": "Retrieves the last login attempt of the user.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "The last login attempt object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "failed" ] }, "timestamp": { "type": "number" }, "location": { "type": "string" } } } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "404": { "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Found" }, "title": { "type": "string", "example": "Not Found Error" }, "status": { "type": "number", "example": 404 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "405": { "description": "The method received in the request-line is known by the origin server but not supported by the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Method Not Allowed" }, "title": { "type": "string", "example": "Method Not Allowed Error" }, "status": { "type": "number", "example": 405 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "409": { "description": "The request conflicts with current state of the server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Conflict" }, "title": { "type": "string", "example": "Conflict Error" }, "status": { "type": "number", "example": 409 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1004 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "413": { "description": "The request entity is larger than limits defined by server.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payload Too Large" }, "title": { "type": "string", "example": "Payload Too Large Error" }, "status": { "type": "number", "example": 413 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "500": { "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Internal Server Error" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "number", "example": 500 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "501": { "description": "The server does not support the functionality required to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Not Implemented" }, "title": { "type": "string", "example": "Not Implemented Error" }, "status": { "type": "number", "example": 501 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1009 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "502": { "description": "The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Gateway" }, "title": { "type": "string", "example": "Bad Gateway Error" }, "status": { "type": "number", "example": 502 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "503": { "description": "The server is not ready to handle the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Service Unavailable" }, "title": { "type": "string", "example": "Service Unavailable Error" }, "status": { "type": "number", "example": 503 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 503 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "504": { "description": "The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Gateway Timeout" }, "title": { "type": "string", "example": "Gateway Timeout Error" }, "status": { "type": "number", "example": 504 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } } }, "security": [ { "APIKeyHeader": [], "APIKeyQueryParam": [], "OAuth2": [] } ] } }, "/v2.0/projects/{projectId}/members/{userId}": { "get": { "operationId": "readProjectMember_2_0", "summary": "Reads a project member.", "description": "Retrieves all information about a project member in a project.", "tags": [ "Users v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the project member with all information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "intents", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "admin" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "acl": { "type": "object" }, "allowedLocales": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "required": [ "_id", "createdAt", "lastChanged", "createdBy", "lastChangedBy" ] } } } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Bad Request" }, "title": { "type": "string", "example": "Bad Request Error" }, "status": { "type": "number", "example": 400 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "401": { "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Unauthorized" }, "title": { "type": "string", "example": "Unauthorized Error" }, "status": { "type": "number", "example": 401 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 401 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "402": { "description": "Upgrade your Plan to increase your Quota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Payment Required" }, "title": { "type": "string", "example": "Payment Required Error" }, "status": { "type": "number", "example": 402 }, "detail": { "type": "string", "example": "Validation failed. Missing payload." }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 402 }, "traceId": { "type": "string", "example": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "details": { "type": "object", "example": {} } } } } } }, "403": { "description": "The server understood the request but refuses to authorize it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "Forbidden" }, "title": { "type": "string", "example": "Forbidden Error" }, "status": { "type": "number", "example": 403 }, "detail": { "type": "string" }, "instance": { "type": "string", "example": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432" }, "code": { "type": "string", "example": 1000 }, "traceId": { "type": "string", "example": "