{ "openapi" : "3.0.1", "info" : { "title" : "novomind iAGENT REST API", "version" : "v2" }, "tags" : [ { "name" : "Accounts" }, { "name" : "Groups" }, { "name" : "Business hours" }, { "name" : "Calls" }, { "name" : "Categories" }, { "name" : "Chat permissions" }, { "name" : "Config" }, { "name" : "Holidays" }, { "name" : "Locations" }, { "name" : "Mailbox" }, { "name" : "Mails" }, { "name" : "Prefilled Reports" }, { "name" : "Reports" }, { "name" : "Routing" }, { "name" : "Search" }, { "name" : "Server Info" }, { "name" : "Tenants" }, { "name" : "Textmodules" }, { "name" : "Transaction Codes" }, { "name" : "Users" }, { "name" : "Interactions" } ], "paths" : { "/api/rest/accounts" : { "get" : { "description" : "Note: The mailboxCount field of the responses, is fetched every 30 seconds.", "operationId" : "accounts", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccountExtendedResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a list of all accounts.", "tags" : [ "Accounts" ] }, "post" : { "description" : "Supported channels are the build-in channels EMAIL, LETTER, FAX and SMS and other custom channels provided by apps. Supported protocols are the build-in protocols POP3, POP3S, IMAP, IMAPS and FILE and other custom protocols provided by apps.", "operationId" : "createAccount", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/AccountResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User not allowed to create new account." }, "500" : { "description" : "Server error" } }, "summary" : "Creates a new incoming or system account with the bare minimum of necessary information.", "tags" : [ "Accounts" ] } }, "/api/rest/accounts/{id}" : { "get" : { "description" : "Note: The mailboxCount field of the response, is fetched every 30 seconds.", "operationId" : "accountForId", "parameters" : [ { "description" : "The account id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/AccountExtendedResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Account not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the account for the given id.", "tags" : [ "Accounts" ] }, "patch" : { "description" : "All attributes are optional, so a single attribute can be updated.The attributes tenantId and alternativeOutgoingAccountId are nullable to delete the assignment.", "operationId" : "updateAccount", "parameters" : [ { "description" : "The account id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountPatchRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/AccountPatchRequest" } } }, "description" : "OK" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User not allowed to edit accounts." }, "404" : { "description" : "Account does not exist" }, "500" : { "description" : "Server error" } }, "summary" : "Updates specific attributes of an incoming or system account.", "tags" : [ "Accounts" ] } }, "/api/rest/accounts/{id}/properties" : { "get" : { "operationId" : "getProperties", "parameters" : [ { "description" : "The account id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Account not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the account properties for the given id.", "tags" : [ "Accounts" ] }, "put" : { "description" : "Possible types are: STRING, ENCRYPTED_STRING, DOUBLE, LONG, BOOLEAN and DATE. The format for the date is yyyy-MM-dd'T'HH:mm:ssZ. Setting a property to null will remove the property.", "operationId" : "setProperties", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "400" : { "description" : "Request malformed or invalid" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Account not found" }, "500" : { "description" : "Server error" } }, "summary" : "Sets the properties for the given id.", "tags" : [ "Accounts" ] } }, "/api/rest/accounts/{id}/properties/{key}" : { "delete" : { "description" : "Note: Deleting multiple properties is possible by using the PUT method with null as values.", "operationId" : "deleteProperties", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Account or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the property entry for the given id and key.", "tags" : [ "Accounts" ] }, "get" : { "operationId" : "getProperty", "parameters" : [ { "description" : "The account id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/Property" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Account or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Returns the value of the property with the given id and key.", "tags" : [ "Accounts" ] } }, "/api/rest/backlog/calls" : { "get" : { "operationId" : "getCalls", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Parameter to filter calls based on a given category.", "in" : "query", "name" : "categoryId", "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "Parameter to filter calls based on a given group.", "in" : "query", "name" : "groupId", "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CallResponse" } } } }, "description" : "OK" }, "404" : { "description" : "Call, Category or group not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all current calls", "tags" : [ "Calls" ] } }, "/api/rest/backlog/calls/{callId}" : { "get" : { "operationId" : "getCallById", "parameters" : [ { "in" : "path", "name" : "callId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/CallResponse" } } }, "description" : "OK" }, "404" : { "description" : "Call not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the given call information", "tags" : [ "Calls" ] } }, "/api/rest/businesshours" : { "get" : { "operationId" : "businessHours", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BusinessHourResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a list of all business hours.", "tags" : [ "Business hours" ] } }, "/api/rest/businesshours/{id}" : { "get" : { "operationId" : "businessHour", "parameters" : [ { "description" : "The account id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/BusinessHourResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the businesshour for the id.", "tags" : [ "Business hours" ] } }, "/api/rest/categories/categories" : { "get" : { "operationId" : "getVisibleCategories", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the visible categories for the current user.", "tags" : [ "Categories" ] }, "post" : { "operationId" : "createCategory", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CategoryRequest" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryResponse" } } }, "description" : "created" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Creates a category.", "tags" : [ "Categories" ] } }, "/api/rest/categories/categories/{id}" : { "delete" : { "operationId" : "deleteCategory", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "no content" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the category for the given id.", "tags" : [ "Categories" ] }, "get" : { "operationId" : "getVisibleCategories_1", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryResponse" } } }, "description" : "OK" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the visible categories with the given ID for the current user.", "tags" : [ "Categories" ] }, "put" : { "operationId" : "editCategory", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CategoryRequest" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryResponse" } } }, "description" : "OK" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Edits the category for the given id.", "tags" : [ "Categories" ] } }, "/api/rest/categories/categories/{id}/appliedbusinesshour" : { "get" : { "operationId" : "getAppliedBusinessHour", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BusinessHourResponse" } } } }, "description" : "OK" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the business hour that is currently applied to the category with the given id.", "tags" : [ "Categories" ] } }, "/api/rest/categories/categories/{id}/assignedsystemgroups" : { "get" : { "operationId" : "getCategorySystemGroups", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SystemGroupResponse" } } } }, "description" : "OK" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the systemgroups for the category with the given id.", "tags" : [ "Categories" ] }, "put" : { "operationId" : "editAssignedSystemgroups", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssignedGroupRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SystemGroupResponse" } } } }, "description" : "OK" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Adds the systemgroups assignments of the category.", "tags" : [ "Categories" ] } }, "/api/rest/categories/categories/{id}/assignedsystemgroups/{systemgroupId}" : { "delete" : { "operationId" : "removeAssignedSystemgroups", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The systemgroup id", "in" : "path", "name" : "systemgroupId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "no content" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Removes the system group assignment from a category.", "tags" : [ "Categories" ] } }, "/api/rest/categories/categories/{id}/assignedtextmodulefirstlevelgroups" : { "get" : { "operationId" : "getCategoryTextModuleFirstLevelGroups", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupResponse" } } } }, "description" : "OK" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the assigned text module first level groups for the category with the given id.", "tags" : [ "Categories" ] }, "put" : { "operationId" : "editAssignedTextModuleFirstLevelGroups", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupResponse" } } } }, "description" : "OK" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Adds the text module first level group assignments of the category.", "tags" : [ "Categories" ] } }, "/api/rest/categories/categories/{id}/assignedtextmodulefirstlevelgroups/{textModuleFirstLevelGroupId}" : { "delete" : { "operationId" : "removeAssignedTextModuleFirstLevelGroup", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The text module first level group id", "in" : "path", "name" : "textModuleFirstLevelGroupId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "no content" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Removes the text module first level group assignment from a category.", "tags" : [ "Categories" ] } }, "/api/rest/categories/categories/{id}/assignedtransactioncodes" : { "get" : { "operationId" : "getCategoryTransactionCodes", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TransactionCodeResponse" } } } }, "description" : "OK" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the transactioncodes for the category with the given id.", "tags" : [ "Categories" ] }, "put" : { "operationId" : "editAssignedTransactionCodes", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssignedTransactionCodeRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TransactionCodeResponse" } } } }, "description" : "OK" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Adds the transactioncode assignments of the category.", "tags" : [ "Categories" ] } }, "/api/rest/categories/categories/{id}/assignedtransactioncodes/{transactionCodeId}" : { "delete" : { "operationId" : "removeAssignedTransactionCode", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The transaction code id", "in" : "path", "name" : "transactionCodeId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "no content" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Removes the transaction code assignment from a category.", "tags" : [ "Categories" ] } }, "/api/rest/categories/categories/{id}/properties" : { "get" : { "operationId" : "getCategoryProperties", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the category properties for the given id.", "tags" : [ "Categories" ] }, "put" : { "description" : "Possible types are: STRING, ENCRYPTED_STRING, DOUBLE, LONG, BOOLEAN and DATE. The format for the date is yyyy-MM-dd'T'HH:mm:ssZ. Setting a property to null will remove the property.", "operationId" : "setProperties_1", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "400" : { "description" : "Request malformed or invalid" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Sets the properties for the given id.", "tags" : [ "Categories" ] } }, "/api/rest/categories/categories/{id}/properties/{key}" : { "delete" : { "description" : "Note: Deleting multiple properties is possible by using the PUT method with null as values.", "operationId" : "deleteProperties_1", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "no content" }, "400" : { "description" : "Request malformed or invalid" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Category or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the property entry for the given id and key.", "tags" : [ "Categories" ] }, "get" : { "operationId" : "getProperty_1", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Category or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Returns the value of the property with the given id and key.", "tags" : [ "Categories" ] } }, "/api/rest/categories/maincategories" : { "get" : { "operationId" : "getVisibleMainCategories", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the visible maincategories for the current user.", "tags" : [ "Categories" ] } }, "/api/rest/categories/maincategories/{id}" : { "get" : { "operationId" : "getVisibleMainCategories_1", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryResponse" } } }, "description" : "OK" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the visible maincategory with the given ID for the current user.", "tags" : [ "Categories" ] } }, "/api/rest/categories/maincategories/{id}/subcategories" : { "get" : { "operationId" : "getSubcategories", "parameters" : [ { "description" : "The category id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "Include deleted categories", "in" : "query", "name" : "withDeleted", "schema" : { "type" : "boolean", "default" : false } }, { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, "404" : { "description" : "Category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the subcategories of the category with the given id.", "tags" : [ "Categories" ] } }, "/api/rest/chat/permissions" : { "get" : { "operationId" : "getChatPermissions", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ChatPermissionModel" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all chatPermissions.", "tags" : [ "Chat permissions" ] }, "post" : { "operationId" : "createChatPermission", "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ChatPermissionRequest" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/ChatPermissionModel" } } }, "description" : "Created" }, "400" : { "description" : "Bad request" }, "500" : { "description" : "Server error" } }, "summary" : "Creates a new ChatPermision.", "tags" : [ "Chat permissions" ] } }, "/api/rest/chat/permissions/{id}" : { "delete" : { "operationId" : "deleteChatPermission", "parameters" : [ { "description" : "The chatPermission id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "no content" }, "400" : { "description" : "Bad request" }, "404" : { "description" : "Not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the ChatPermission with the given id.", "tags" : [ "Chat permissions" ] }, "get" : { "operationId" : "getChatPermission", "parameters" : [ { "description" : "The chatPermission id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/ChatPermissionModel" } } }, "description" : "OK" }, "400" : { "description" : "Bad request" }, "404" : { "description" : "Not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the chatPermission with the given id.", "tags" : [ "Chat permissions" ] }, "put" : { "operationId" : "updateChatPermission", "parameters" : [ { "description" : "The chatPermission id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ChatPermissionRequest" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/ChatPermissionModel" } } }, "description" : "Ok" }, "400" : { "description" : "Bad request" }, "404" : { "description" : "Not found" }, "500" : { "description" : "Server error" } }, "summary" : "Updates a ChatPermision.", "tags" : [ "Chat permissions" ] } }, "/api/rest/chatbots" : { "get" : { "operationId" : "getChatBots", "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ChatBotResponse" } } } }, "description" : "OK" }, "403" : { "description" : "Forbidden" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a list of all chatbots.", "tags" : [ "Chatbots" ] }, "post" : { "operationId" : "createChatBot", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChatBotRequest" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/ChatBotResponse" } } }, "description" : "created" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Chatbot not found" }, "500" : { "description" : "Server error" } }, "summary" : "Creates a chatbot.", "tags" : [ "Chatbots" ] } }, "/api/rest/chatbots/{id}" : { "delete" : { "operationId" : "deleteChatBot", "parameters" : [ { "description" : "The Chatbot Id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/ChatBotResponse" } } }, "description" : "no content" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Chatbot not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes an existing Chatbot.", "tags" : [ "Chatbots" ] }, "get" : { "operationId" : "getChatBot", "parameters" : [ { "description" : "The Chatbot Id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ChatBotResponse" } } } }, "description" : "OK" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Chatbot not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a chatbot.", "tags" : [ "Chatbots" ] }, "put" : { "description" : "The tenantId or timeouts (e.g. inactivityTimeout) can be removed by setting the value to -1.", "operationId" : "modifyChatBot", "parameters" : [ { "description" : "The Chatbot Id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChatBotRequest" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/ChatBotResponse" } } }, "description" : "ok" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Chatbot not found" }, "500" : { "description" : "Server error" } }, "summary" : "Modifies an existing Chatbot.", "tags" : [ "Chatbots" ] } }, "/api/rest/chatbots/{id}/assignedcategories" : { "get" : { "operationId" : "getAssignedCategories_1", "parameters" : [ { "description" : "The id of the Chatbot", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Chatbot not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the assigned categories of the Chatbot with the given id.", "tags" : [ "Chatbots" ] }, "put" : { "operationId" : "addAssignedCategory_1", "parameters" : [ { "description" : "The id of the Chatbot", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssignedCategoryRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, "400" : { "description" : "No categories specified." }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Chatbot or category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Assigns the categories to this Chatbot.", "tags" : [ "Chatbots" ] } }, "/api/rest/chatbots/{id}/assignedcategories/{categoryId}" : { "delete" : { "operationId" : "removeAssignedCategory_1", "parameters" : [ { "description" : "The id of the Chatbot", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The id of the category to remove", "in" : "path", "name" : "categoryId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to remove a category assignment of this Chatbot." }, "404" : { "description" : "Chatbot or category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Removes the assigned category from this Chatbot.", "tags" : [ "Chatbots" ] } }, "/api/rest/config/core" : { "put" : { "operationId" : "setMailProperty", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Property" } } }, "description" : "The query with the key and value" }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/Property" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Sets a property in the nmIQMail.cfg. Creates the key value pair if the key didn't exist before.", "tags" : [ "Config" ] } }, "/api/rest/config/routing" : { "put" : { "operationId" : "setProperty", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Property" } } }, "description" : "The query with the key and value" }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/Property" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Sets a property in the Routing.conf. Creates the key value pair if the key didn't exist before.", "tags" : [ "Config" ] } }, "/api/rest/groups/agentgroups" : { "get" : { "operationId" : "getAllowedAgentGroups", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AgentGroupResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all allowed agent groups for the current user.", "tags" : [ "Groups" ] }, "post" : { "description" : "Parameter name and parentId are required.", "operationId" : "createAgentGroup", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AgentGroupRequest" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/AgentGroupResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User not allowed to create new agent groups." }, "500" : { "description" : "Server error" } }, "summary" : "Creates a new agent group.", "tags" : [ "Groups" ] } }, "/api/rest/groups/agentgroups/{id}" : { "delete" : { "operationId" : "deleteAgentGroup", "parameters" : [ { "description" : "The id of the agent group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to delete an agent group." }, "404" : { "description" : "Agent group not found" }, "500" : { "description" : "Server error" } }, "summary" : "Delete the agent group with the given id if the user is allowed to see this agent group. The agent group is only marked as deleted.", "tags" : [ "Groups" ] }, "get" : { "operationId" : "getAgentGroup", "parameters" : [ { "description" : "The id of the agent group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/AgentGroupResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this system group." }, "404" : { "description" : "Agent group not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the agent group with the given id if the user is allowed to see this agent group.", "tags" : [ "Groups" ] }, "put" : { "operationId" : "updateAgentGroup", "parameters" : [ { "description" : "The id of the agent group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AgentGroupRequest" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/AgentGroupResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not allowed to update an agent group." }, "404" : { "description" : "Agent group not found" }, "500" : { "description" : "Server error" } }, "summary" : "Updates the agent group with the given id if the user is allowed to see this agent group.", "tags" : [ "Groups" ] } }, "/api/rest/groups/agentgroups/{id}/assignedcategories" : { "get" : { "operationId" : "getAssignedCategories", "parameters" : [ { "description" : "The id of the agentgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this agentgroup." }, "404" : { "description" : "Agentgroup not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the assigned categories of the agentgroup with the given id if the user is allowed to see this agentgroup.", "tags" : [ "Groups" ] }, "put" : { "operationId" : "addAssignedCategory", "parameters" : [ { "description" : "The id of the agentgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssignedCategoryRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, "400" : { "description" : "No categories specified." }, "403" : { "description" : "User not allowed to update an agentgroup." }, "404" : { "description" : "Agentgroup or category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Assigns the categories to this agentgroup if the user is allowed to see this agentgroup.", "tags" : [ "Groups" ] } }, "/api/rest/groups/agentgroups/{id}/assignedcategories/{categoryId}" : { "delete" : { "operationId" : "removeAssignedCategory", "parameters" : [ { "description" : "The id of the agentgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The id of the category to remove", "in" : "path", "name" : "categoryId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to remove a category assignment of this agentgroup." }, "404" : { "description" : "Agentgroup or category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Removes the assigned category from this agentgroup.", "tags" : [ "Groups" ] } }, "/api/rest/groups/agentgroups/{id}/userassignments" : { "get" : { "operationId" : "getUserAssignments", "parameters" : [ { "description" : "The id of the agentgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserAgentGroupAssignmentResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this agentgroup." }, "404" : { "description" : "Agentgroup not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the assigned users with their individual skill of the agentgroup with the given id if the user is allowed to see this agentgroup.", "tags" : [ "Groups" ] }, "put" : { "operationId" : "addUserAssignments", "parameters" : [ { "description" : "The id of the agentgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserAgentGroupAssignmentRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserAgentGroupAssignmentResponse" } } } }, "description" : "OK" }, "400" : { "description" : "No users specified." }, "403" : { "description" : "User not allowed to update an agentgroup." }, "404" : { "description" : "Agentgroup or user not found" }, "500" : { "description" : "Server error" } }, "summary" : "Assigns the users to this agentgroup if the user is allowed to see this agentgroup.", "tags" : [ "Groups" ] } }, "/api/rest/groups/agentgroups/{id}/userassignments/{userId}" : { "delete" : { "operationId" : "removeUserAssignment", "parameters" : [ { "description" : "The id of the agentgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The id of the user to remove", "in" : "path", "name" : "userId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to remove an user assignment of this agentgroup." }, "404" : { "description" : "Agentgroup or user not found" }, "500" : { "description" : "Server error" } }, "summary" : "Removes the assigned user from this agentgroup.", "tags" : [ "Groups" ] } }, "/api/rest/groups/systemgroups" : { "get" : { "operationId" : "getAllowedSystemGroups", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SystemGroupResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all allowed system groups for the current user.", "tags" : [ "Groups" ] }, "post" : { "description" : "Parameter name and parentId are required.", "operationId" : "createSystemGroup", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SystemGroupRequest" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/SystemGroupResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User not allowed to create new system groups." }, "500" : { "description" : "Server error" } }, "summary" : "Creates a new system group.", "tags" : [ "Groups" ] } }, "/api/rest/groups/systemgroups/{id}" : { "delete" : { "operationId" : "deleteSystemGroup", "parameters" : [ { "description" : "The id of the system group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to delete a system group." }, "404" : { "description" : "System group not found" }, "500" : { "description" : "Server error" } }, "summary" : "Delete the system group with the given id if the user is allowed to see this system group. The system group is only marked as deleted.", "tags" : [ "Groups" ] }, "get" : { "operationId" : "getSystemGroup", "parameters" : [ { "description" : "The id of the system group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/SystemGroupResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this system group." }, "404" : { "description" : "System group not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the system group with the given id if the user is allowed to see this system group.", "tags" : [ "Groups" ] }, "put" : { "operationId" : "updateSystemGroup", "parameters" : [ { "description" : "The id of the system group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SystemGroupRequest" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/SystemGroupResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not allowed to update a system group." }, "404" : { "description" : "System group not found" }, "500" : { "description" : "Server error" } }, "summary" : "Updates the system group with the given id if the user is allowed to see this system group.", "tags" : [ "Groups" ] } }, "/api/rest/groups/systemgroups/{id}/assignedcategories" : { "get" : { "operationId" : "getAssignedCategories_2", "parameters" : [ { "description" : "The id of the systemgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this systemgroup." }, "404" : { "description" : "Systemgroup not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the assigned categories of the systemgroup with the given id if the user is allowed to see this systemgroup.", "tags" : [ "Groups" ] }, "put" : { "operationId" : "addAssignedCategory_2", "parameters" : [ { "description" : "The id of the systemgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssignedCategoryRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, "400" : { "description" : "No categories specified." }, "403" : { "description" : "User not allowed to update an systemgroup." }, "404" : { "description" : "Systemgroup or category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Assigns the categories to this systemgroup if the user is allowed to see this systemgroup.", "tags" : [ "Groups" ] } }, "/api/rest/groups/systemgroups/{id}/assignedcategories/{categoryId}" : { "delete" : { "operationId" : "removeAssignedCategory_2", "parameters" : [ { "description" : "The id of the systemgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The id of the category to remove", "in" : "path", "name" : "categoryId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to remove a category assignment of this systemgroup." }, "404" : { "description" : "Systemgroup or category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Removes the assigned category from this systemgroup.", "tags" : [ "Groups" ] } }, "/api/rest/groups/systemgroups/{id}/assignedprivileges" : { "get" : { "operationId" : "getAssignedPrivileges_1", "parameters" : [ { "description" : "The id of the systemgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PrivilegeResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this systemgroup." }, "404" : { "description" : "Systemgroup not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the assigned privileges of the systemgroup with the given id if the user is assigned to this systemgroup.", "tags" : [ "Groups" ] }, "put" : { "operationId" : "addAssignedPrivileges", "parameters" : [ { "description" : "The id of the systemgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssignedPrivilegeRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PrivilegeResponse" } } } }, "description" : "OK" }, "400" : { "description" : "No privileges specified." }, "403" : { "description" : "User not allowed to update a systemgroup." }, "404" : { "description" : "Systemgroup or privilege not found" }, "500" : { "description" : "Server error" } }, "summary" : "Assigns the privileges to this systemgroup if the user is assigned to this systemgroup.", "tags" : [ "Groups" ] } }, "/api/rest/groups/systemgroups/{id}/assignedprivileges/{privilegeId}" : { "delete" : { "operationId" : "removeAssignedPrivilege", "parameters" : [ { "description" : "The id of the systemgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The id of the privilege to remove", "in" : "path", "name" : "privilegeId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "No privileges specified or systemgroup is administration group." }, "403" : { "description" : "User not allowed to remove a privilege assignment of this systemgroup." }, "404" : { "description" : "Systemgroup or privilege not found" }, "500" : { "description" : "Server error" } }, "summary" : "Removes the assigned privilege from this systemgroup.", "tags" : [ "Groups" ] } }, "/api/rest/groups/systemgroups/{id}/assignedusers" : { "get" : { "operationId" : "getAssignedUsers", "parameters" : [ { "description" : "The id of the systemgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this systemgroup." }, "404" : { "description" : "Systemgroup not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the assigned users of the systemgroup with the given id if the user is allowed to see this systemgroup.", "tags" : [ "Groups" ] }, "put" : { "operationId" : "addAssignedUsers", "parameters" : [ { "description" : "The id of the systemgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssignedUserRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserResponse" } } } }, "description" : "OK" }, "400" : { "description" : "No users specified." }, "403" : { "description" : "User not allowed to update a systemgroup." }, "404" : { "description" : "Systemgroup or user not found" }, "500" : { "description" : "Server error" } }, "summary" : "Assigns the users to this systemgroup if the user is allowed to see this systemgroup.", "tags" : [ "Groups" ] } }, "/api/rest/groups/systemgroups/{id}/assignedusers/{userId}" : { "delete" : { "operationId" : "removeAssignedUser", "parameters" : [ { "description" : "The id of the systemgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The id of the user to remove", "in" : "path", "name" : "userId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to remove a user assignment of this systemgroup." }, "404" : { "description" : "Systemgroup or user not found" }, "500" : { "description" : "Server error" } }, "summary" : "Removes the assigned user from this systemgroup.", "tags" : [ "Groups" ] } }, "/api/rest/groups/systemgroups/{id}/childagentgroups" : { "get" : { "operationId" : "getChildAgentGroups", "parameters" : [ { "description" : "The id of the systemgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AgentGroupResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this systemgroup." }, "404" : { "description" : "Systemgroup not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the child agentgroups of the systemgroup with the given id if the user is allowed to see this systemgroup.", "tags" : [ "Groups" ] } }, "/api/rest/groups/systemgroups/{id}/childsystemgroups" : { "get" : { "operationId" : "getChildSystemGroups", "parameters" : [ { "description" : "The id of the systemgroup", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SystemGroupResponse" } } } }, "description" : "Ok" }, "403" : { "description" : "User not assigned to this systemgroup." }, "404" : { "description" : "Systemgroup not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the child systemgroups of the systemgroup with the given id if the user is allowed to see this systemgroup.", "tags" : [ "Groups" ] } }, "/api/rest/holidays" : { "get" : { "operationId" : "holidays", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HolidayListResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a list of all holidays.", "tags" : [ "Holidays" ] } }, "/api/rest/holidays/{id}" : { "get" : { "operationId" : "holiday", "parameters" : [ { "description" : "The holiday id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HolidayListResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the holiday for the id.", "tags" : [ "Holidays" ] } }, "/api/rest/interaction" : { "get" : { "operationId" : "showInteractions", "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a list of possible interaction resources.", "tags" : [ "Interactions" ] } }, "/api/rest/interaction/agent" : { "get" : { "operationId" : "showAgentInteractions", "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a list of possible agent interactions.", "tags" : [ "Interactions" ] } }, "/api/rest/interaction/agent/notification" : { "post" : { "description" : "Note: The notification can only be shown if the web browser supports this feature (https://developer.mozilla.org/en-US/docs/Web/API/notification#Browser_compatibility).", "operationId" : "showNotification", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NotificationParameter" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/StatusResponse" } } }, "description" : "OK" }, "401" : { "description" : "User not authorized" }, "404" : { "description" : "User not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a browser notification to the given agent.", "tags" : [ "Interactions" ] } }, "/api/rest/interaction/agent/tabs" : { "get" : { "operationId" : "showAgentTabInteractions", "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a list of agent interactions for the tabs.", "tags" : [ "Interactions" ] } }, "/api/rest/interaction/agent/tabs/new-case" : { "put" : { "description" : "The ID in the attachments refers to an external data source and is optional. It should only be set if a Custom-Attachment-Provider was implemented.", "operationId" : "swithToNewCase", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NewCaseParameters" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/StatusResponse" } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Switches the GUI from the given agent to the new case view.", "tags" : [ "Interactions" ] } }, "/api/rest/interaction/agent/tabs/voice" : { "get" : { "operationId" : "showAgentVoiceTabInteractions", "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a list of agent interactions for the voice tabs.", "tags" : [ "Interactions" ] } }, "/api/rest/interaction/agent/tabs/voice/new-call" : { "put" : { "description" : "The ID in the attachments refers to an external data source and is optional. It should only be set if a Custom-Attachment-Provider was implemented.", "operationId" : "swithToICall", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NewCallParameters" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/StatusResponse" } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Service for switching to the iCall tab or indicate an incoming call.", "tags" : [ "Interactions" ] } }, "/api/rest/interaction/agent/tabs/voice/ringing" : { "put" : { "deprecated" : true, "description" : "The timeout value is in milliseconds. Valid values for action are \"start\" and \"stop\". You can also start the ringing event without a timout. Set the action to stop for stopping the ringing event.", "operationId" : "setSignal", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SignalParameter" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/StatusResponse" } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Sets the signal for incoming iCall requests.", "tags" : [ "Interactions" ] } }, "/api/rest/locations" : { "get" : { "operationId" : "getAllowedLocations", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LocationResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all allowed locations for the current user.", "tags" : [ "Locations" ] }, "post" : { "description" : "Parameter name is required.", "operationId" : "createLocation", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LocationRequest" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/LocationResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User not allowed to create new locations." }, "500" : { "description" : "Server error" } }, "summary" : "Creates a new location.", "tags" : [ "Locations" ] } }, "/api/rest/locations/{id}" : { "delete" : { "operationId" : "deleteLocation", "parameters" : [ { "description" : "The location id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to delete a location." }, "404" : { "description" : "Location not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the location with the given id if the user is allowed to see this location. The location is only marked as deleted.", "tags" : [ "Locations" ] }, "get" : { "operationId" : "getLocation", "parameters" : [ { "description" : "The location id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/LocationResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to location." }, "404" : { "description" : "Location not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the location with the given id if the user is allowed to see this location.", "tags" : [ "Locations" ] }, "put" : { "operationId" : "updateLocation", "parameters" : [ { "description" : "The location id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LocationRequest" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/LocationResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not allowed to update a location." }, "404" : { "description" : "Location not found" }, "500" : { "description" : "Server error" } }, "summary" : "Updates the location with the given id if the user is allowed to see this location.", "tags" : [ "Locations" ] } }, "/api/rest/locations/{id}/properties" : { "get" : { "operationId" : "getProperties_1", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Location not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the properties for the given id.", "tags" : [ "Locations" ] }, "put" : { "description" : "Possible types are: STRING, ENCRYPTED_STRING, DOUBLE, LONG, BOOLEAN and DATE. The format for the date is yyyy-MM-dd'T'HH:mm:ssZ. Setting a property to null will remove the property.", "operationId" : "setProperties_2", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "400" : { "description" : "Request malformed or invalid" }, "404" : { "description" : "Location not found" }, "500" : { "description" : "Server error" } }, "summary" : "Sets the properties for the given id.", "tags" : [ "Locations" ] } }, "/api/rest/locations/{id}/properties/{key}" : { "delete" : { "description" : "Note: Deleting multiple properties is possible by using the PUT method with null as values.", "operationId" : "deleteProperties_2", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Request malformed or invalid" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Location or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the property entry for the given id and key.", "tags" : [ "Locations" ] }, "get" : { "operationId" : "getProperty_2", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Location or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Returns the value of the property with the given id and key.", "tags" : [ "Locations" ] } }, "/api/rest/mailbox" : { "get" : { "operationId" : "globalMailbox", "parameters" : [ { "description" : "The category name", "in" : "query", "name" : "cat", "schema" : { "type" : "string" } }, { "description" : "Request origin", "in" : "header", "name" : "Origin", "schema" : { "type" : "string" } }, { "description" : "The filter for the mailbox", "in" : "query", "name" : "filter", "schema" : { "type" : "string" } }, { "description" : "The order key", "in" : "query", "name" : "orderKey", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Order descending?", "in" : "query", "name" : "orderDesc", "schema" : { "type" : "boolean" } }, { "description" : "Maximum number of mails", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/MailboxResponse" } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the mails for the global inbox.", "tags" : [ "Mailbox" ] } }, "/api/rest/mailbox/{folder}" : { "get" : { "operationId" : "mailbox", "parameters" : [ { "in" : "path", "name" : "folder", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The category name", "in" : "query", "name" : "cat", "schema" : { "type" : "string" } }, { "description" : "Request origin", "in" : "header", "name" : "Origin", "schema" : { "type" : "string" } }, { "description" : "The filter for the mailbox", "in" : "query", "name" : "filter", "schema" : { "type" : "string" } }, { "description" : "The order key", "in" : "query", "name" : "orderKey", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Order descending?", "in" : "query", "name" : "orderDesc", "schema" : { "type" : "boolean" } }, { "description" : "Maximum number of mails", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/MailboxResponse" } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the mails for the given inbox/username.", "tags" : [ "Mailbox" ] } }, "/api/rest/mails" : { "post" : { "description" : "When providing an EML file, the message may be categorized immediately after creation. If the user does not have the privileges to see messages in this category, then the response will contain this category anyway. This only applies for this specific case. All following requests for this message will check for privileges as usual.", "operationId" : "addMessage", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MailParameters" } }, "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/EmlParameter" } } }, "description" : "The mail to add" }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/MailResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Adds a new message.", "tags" : [ "Mails" ] } }, "/api/rest/mails/{id}" : { "get" : { "operationId" : "getMailInfo", "parameters" : [ { "description" : "The mail id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/MailResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to use this operation" }, "404" : { "description" : "Mail not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the mail information for the given id.", "tags" : [ "Mails" ] } }, "/api/rest/mails/{id}/answer/eml" : { "get" : { "operationId" : "getAnswerEml", "parameters" : [ { "description" : "The mail id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" }, "403" : { "description" : "User is not allowed to use this operation" }, "404" : { "description" : "Mail not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the mail in an eml format for the given id.", "tags" : [ "Mails" ] } }, "/api/rest/mails/{id}/close" : { "post" : { "description" : "Parameter transactionCodeId is required if a transaction code is required for the mail category and context is \"agent\". The parameter is not allowed if context is \"supervisor\". Query parameter context has to be \"agent\" or \"supervisor\".", "operationId" : "close", "parameters" : [ { "description" : "The mail id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The context (\"agent\" or \"supervisor\") of the request", "in" : "query", "name" : "context", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CloseParameters" } } } }, "responses" : { "200" : { "description" : "OK" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Mail not found" }, "500" : { "description" : "Server error" } }, "summary" : "Closes a mail.", "tags" : [ "Mails" ] } }, "/api/rest/mails/{id}/message/eml" : { "get" : { "operationId" : "getMessageEml", "parameters" : [ { "description" : "The mail id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" }, "403" : { "description" : "User is not allowed to use this operation" }, "404" : { "description" : "Mail not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the mail in an eml format for the given id.", "tags" : [ "Mails" ] } }, "/api/rest/mails/{id}/notes" : { "get" : { "operationId" : "getNotesforMailId", "parameters" : [ { "description" : "The mail id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NoteResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to use this operation" }, "404" : { "description" : "Mail not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the notes of a mail and its corresponding process.", "tags" : [ "Mails" ] }, "post" : { "description" : "Parameter text is required.", "operationId" : "addNote", "parameters" : [ { "description" : "The mail id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NoteParameters" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/NoteResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "500" : { "description" : "Server error" } }, "summary" : "Adds a note to a mail.", "tags" : [ "Mails" ] } }, "/api/rest/mails/{id}/properties" : { "get" : { "operationId" : "getPropertiesForMailId", "parameters" : [ { "description" : "The mail id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to use this operation" }, "404" : { "description" : "Mail not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the properties of a mail.", "tags" : [ "Mails" ] }, "put" : { "description" : "Possible types are: STRING, ENCRYPTED_STRING, DOUBLE, LONG, BOOLEAN and DATE. The format for the date is yyyy-MM-dd'T'HH:mm:ssZ. Setting a property to null will remove the property.", "operationId" : "setProperties_3", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "400" : { "description" : "Request malformed or invalid" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Message not found" }, "500" : { "description" : "Server error" } }, "summary" : "Sets the properties for the given id.", "tags" : [ "Mails" ] } }, "/api/rest/mails/{id}/properties/{key}" : { "delete" : { "description" : "Note: Deleting multiple properties is possible by using the PUT method with null as values.", "operationId" : "deleteProperties_3", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "no content" }, "403" : { "description" : "User is not allowed to use this operation" }, "404" : { "description" : "Message or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the property entry for the given id and key.", "tags" : [ "Mails" ] }, "get" : { "operationId" : "getProperty_3", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/Property" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to use this operation" }, "404" : { "description" : "Message or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Returns the value of the property with the given id and key.", "tags" : [ "Mails" ] } }, "/api/rest/phonesystems" : { "get" : { "operationId" : "phoneSystems", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PhoneSystemResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a list of all phone system plugins.", "tags" : [ "Phonesystem plugins" ] }, "post" : { "operationId" : "createPhoneSystem", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PhoneSystemRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PhoneSystemResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User not allowed to create new phone system plugin" }, "500" : { "description" : "Server error" } }, "summary" : "Creates a new phone system plugin with the bare minimum of necessary information.", "tags" : [ "Phonesystem plugins" ] } }, "/api/rest/phonesystems/{id}" : { "delete" : { "operationId" : "deletePhoneSystem", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "Phonesystem plugin is enabled" }, "404" : { "description" : "Phonesystem plugin not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the phone system plugin with the given id if the phone system plugin is not enabled. The phone system plugin is only marked as deleted.", "tags" : [ "Phonesystem plugins" ] }, "get" : { "operationId" : "phoneSystemForId", "parameters" : [ { "description" : "The phone system plugin id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PhoneSystemResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Phone system plugin not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the phone system plugin for the given id.", "tags" : [ "Phonesystem plugins" ] }, "patch" : { "description" : "All attributes are optional, so a single attribute can be updated.", "operationId" : "updatePhoneSystem", "parameters" : [ { "description" : "The phone system plugin id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PhoneSystemRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PhoneSystemRequest" } } }, "description" : "OK" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User not allowed to edit phone system plugins" }, "404" : { "description" : "Phone system plugin does not exist" }, "500" : { "description" : "Server error" } }, "summary" : "Updates specific attributes of a phone system plugin.", "tags" : [ "Phonesystem plugins" ] } }, "/api/rest/phonesystems/{id}/properties" : { "get" : { "operationId" : "getProperties_2", "parameters" : [ { "description" : "The phone system plugin id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Phone system plugin not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the phone system plugin properties for the given id.", "tags" : [ "Phonesystem plugins" ] }, "put" : { "description" : "Possible types are: STRING, ENCRYPTED_STRING, DOUBLE, LONG, BOOLEAN and DATE. The format for the date is yyyy-MM-dd'T'HH:mm:ssZ. Setting a property to null will remove the property.", "operationId" : "setProperties_4", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "400" : { "description" : "Request malformed or invalid" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Phone system plugin not found" }, "500" : { "description" : "Server error" } }, "summary" : "Sets the properties for the given id.", "tags" : [ "Phonesystem plugins" ] } }, "/api/rest/phonesystems/{id}/properties/{key}" : { "delete" : { "description" : "Note: Deleting multiple properties is possible by using the PUT method with null as values.", "operationId" : "deleteProperties_4", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Phonesystem plugin or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the property entry for the given id and key.", "tags" : [ "Phonesystem plugins" ] }, "get" : { "operationId" : "getProperty_4", "parameters" : [ { "description" : "The phone system plugin id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/Property" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Phonesystem plugin or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Returns the value of the property with the given id and key.", "tags" : [ "Phonesystem plugins" ] } }, "/api/rest/prefilledreports" : { "get" : { "operationId" : "getAllowedReportFavorites", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PreFilledReportResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all allowed prefilled reports", "tags" : [ "Prefilled Reports" ] } }, "/api/rest/prefilledreports/{id}" : { "get" : { "operationId" : "getReportInfo", "parameters" : [ { "description" : "The report uid", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/ReportResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to use this report" }, "404" : { "description" : "Report not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the prefilled report information for the given id", "tags" : [ "Prefilled Reports" ] } }, "/api/rest/prefilledreports/{id}/execute" : { "get" : { "operationId" : "executeXLS", "parameters" : [ { "description" : "The report uid", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "Parameter for choosing the preferred locale", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+vnd.ms-excel" : { "schema" : { "$ref" : "#/components/schemas/ReportResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to use this report" }, "404" : { "description" : "Report not found" }, "500" : { "description" : "Server error" } }, "summary" : "exceutes prefilled report and return the excel file", "tags" : [ "Prefilled Reports" ] } }, "/api/rest/privileges" : { "get" : { "operationId" : "getAssignedPrivileges", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PrivilegeResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all privileges assigned to the user.", "tags" : [ "Privileges" ] } }, "/api/rest/reports" : { "get" : { "operationId" : "getAllowedReports", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReportResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all allowed reports for the current user.", "tags" : [ "Reports" ] } }, "/api/rest/reports/{uid}" : { "get" : { "operationId" : "getReportInfo_1", "parameters" : [ { "description" : "The report uid", "in" : "path", "name" : "uid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/ReportResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to use this report" }, "404" : { "description" : "Report not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the reports information for the given uid.", "tags" : [ "Reports" ] } }, "/api/rest/reports/{uid}/execute" : { "post" : { "description" : "To execute a report POST a query as application/json like this.\nBe aware that timestamps do not include millis and need to define the utc offset.\n\n {\n \"from\": \"1970-01-01T00:00:00+0000\",\n \"to\": \"2020-05-04T23:59:59+0200\",\n \"grouping\": [],\n \"parameters\": [\n {\n \"parameter\": \"Category\",\n \"values\": [\"25\",\"26\"]\n },{\n \"parameter\": \"Tenant\",\n \"values\":[\"99\"]\n }\n ]\n }", "operationId" : "generateReport", "parameters" : [ { "description" : "The report uid", "in" : "path", "name" : "uid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportRequest" } } } }, "responses" : { "200" : { "description" : "OK" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "user is not allowed to see the requested data" }, "404" : { "description" : "Report not found" }, "500" : { "description" : "Server error" } }, "summary" : "Excecutes a report.", "tags" : [ "Reports" ] } }, "/api/rest/routing" : { "get" : { "operationId" : "stats", "responses" : { " 200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/RoutingInfoResponse" } } }, "description" : "OK" }, " 403" : { "description" : "User is not allowed to execute this operation" }, " 500" : { "description" : "Server error" } }, "summary" : "Shows the routing statistics of the novomind iAGENT system", "tags" : [ "Routing" ] } }, "/api/rest/routing/start" : { "put" : { "operationId" : "startRouting", "responses" : { " 204" : { "description" : "Routing started" }, " 403" : { "description" : "User is not allowed to execute this operation" }, " 500" : { "description" : "Server error" } }, "summary" : "Starts the routing of the novomind iAGENT system", "tags" : [ "Routing" ] } }, "/api/rest/routing/stop" : { "put" : { "operationId" : "stopRouting", "responses" : { " 204" : { "description" : "Routing stopped" }, " 403" : { "description" : "User is not allowed to execute this operation" }, " 500" : { "description" : "Server error" } }, "summary" : "Stops the routing of the novomind iAGENT system", "tags" : [ "Routing" ] } }, "/api/rest/routingtags" : { "get" : { "operationId" : "getRoutingTags", "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoutingTagResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a list of all routingtags.", "tags" : [ "RoutingTags" ] } }, "/api/rest/routingtags/{id}" : { "get" : { "operationId" : "getRoutingTagForId", "parameters" : [ { "description" : "The routingtag id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoutingTagResponse" } } } }, "description" : "OK" }, "404" : { "description" : "Routingtag not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the routingtag for a given id.", "tags" : [ "RoutingTags" ] } }, "/api/rest/search/chats" : { "get" : { "operationId" : "getChats", "parameters" : [ { "description" : "The search query in json format. \nAllowed parameters for the search query are: \n\nid: Long\n\nIf Solr search is enabled, the following parameters can also be used: \n\nfrom: DateString, date received from e.g. \"2016-09-20T16:08:37+0200\"\n\nto: DateString, date received to e.g. \"2016-09-20T16:08:37+0200\" \n\ncategory: List<String>, categorynames \n\nagents: List<String>, usernames \n\nstatus: List<String>, allowed values are closed, agent unavailable, timeout, out of businesshour, error\n\ntext: String, text to search for.\n\n", "in" : "query", "name" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ChatResponse" } } } }, "description" : "OK" }, "400" : { "description" : "Request malformed" }, "500" : { "description" : "Server error" }, "501" : { "description" : "Not implemented" } }, "summary" : "This service searches for chats that match the given criteria", "tags" : [ "Search" ] } }, "/api/rest/search/mails" : { "get" : { "operationId" : "getMailsForProcess", "parameters" : [ { "description" : "The search query in json format. \nAllowed parameters for the search query are: \n\nrefid: String \nprocessid: Long \nfrom: DateString, date received from e.g. \"2016-09-20T16:08:37+0200\"\nto: DateString, date received to e.g. \"2016-09-20T16:08:37+0200\" \n\nIf Solr search is enabled, the following parameters can also be used: \n\naccountid: List<Long>, acountids \nattachment: String, name of attachment \nattributes: Map<String, String>, email Properties \ncategory: List<String>, categorynames \nchannel: List<String>, allowed values: email, letter, fax, call, sms, som \nclerk: List<String>, usernames \ncompletioncodeid: List<Long>, completioncodeids \nemailCC: String \nemailFrom: String \nemailReplyTo: String \nfromProcessed: DateString, date processed from e.g. \"2016-09-20T16:08:37+0200\"\nmandant: List<String>, mandantnames \nstatus: List<String>, allowed values: open, queued, forwarded, forext, inquiry, clearance, completed, answered, woreply, error, fewcompleted \ntext: String, text to search for. Can also be used to search for emails of one contact, by entering contacts name. \ntoProcessed: DateString, date processed to e.g. \"2016-09-20T16:08:37+0200\"\n", "in" : "query", "name" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MailResponse" } } } }, "description" : "OK" }, "400" : { "description" : "Request malformed" }, "500" : { "description" : "Server error" }, "501" : { "description" : "Not implemented" } }, "summary" : "This service searches for mails that match the given criteria", "tags" : [ "Search" ] } }, "/api/rest/server-info" : { "get" : { "operationId" : "info", "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/ServerInfoResponse" } } }, "description" : "The basic novomind iAGENT inforamtion in json format" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows basic novomind iAGENT information.", "tags" : [ "Server Info" ] } }, "/api/rest/server-info/agents" : { "get" : { "operationId" : "stats_1", "parameters" : [ { "in" : "query", "name" : "cat[]", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/AgentInfoResponse" } } }, "description" : "Returns a Map with the stats name as Key and the stats value as the map value." }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows Agent and mail statistics for the novomind iAGENT system.", "tags" : [ "Server Info" ] } }, "/api/rest/server-info/cti" : { "get" : { "operationId" : "cti", "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/CtiInfoResponse" } } }, "description" : "The cti info in json format" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the cti infos of the novomind iAGENT system.", "tags" : [ "Server Info" ] } }, "/api/rest/server-info/health" : { "get" : { "operationId" : "health", "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/HealthInfoResponse" } } }, "description" : "The healthstate in json format" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the healthstate of the novomind iAGENT system server.", "tags" : [ "Server Info" ] } }, "/api/rest/server-info/health/accounts" : { "get" : { "description" : "Note: The mailboxCount field of the responses, is fetched every 30 seconds.", "operationId" : "getSystemAccounts", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MonitoringAccountResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Shows a list of all system accounts.", "tags" : [ "Server Info" ] } }, "/api/rest/tenants" : { "get" : { "operationId" : "getAllowedTenants", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TenantResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all allowed tenants for the current user.", "tags" : [ "Tenants" ] }, "post" : { "description" : "Parameter name is required.", "operationId" : "createTenant", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TenantRequest" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TenantResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "500" : { "description" : "Server error" } }, "summary" : "Creates a new tenant.", "tags" : [ "Tenants" ] } }, "/api/rest/tenants/{id}" : { "delete" : { "operationId" : "deleteTenant", "parameters" : [ { "description" : "The tenant id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not assigned to tenant." }, "404" : { "description" : "Tenant not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the tenant with the given id if the user is assigend to this tenant. The tenant is only marked as deleted.", "tags" : [ "Tenants" ] }, "get" : { "operationId" : "getTenant", "parameters" : [ { "description" : "The tenant id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TenantResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to tenant." }, "404" : { "description" : "Tenant not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the tenant with the given id if the user is assigend to this tenant.", "tags" : [ "Tenants" ] }, "put" : { "operationId" : "updateTenant", "parameters" : [ { "description" : "The tenant id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TenantRequest" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TenantResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to tenant." }, "404" : { "description" : "Tenant not found" }, "500" : { "description" : "Server error" } }, "summary" : "Updates the tenant with the given id if the user is assigend to this tenant.", "tags" : [ "Tenants" ] } }, "/api/rest/tenants/{id}/properties" : { "get" : { "operationId" : "getProperties_3", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Tenant not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the properties for the given id.", "tags" : [ "Tenants" ] }, "put" : { "description" : "Possible types are: STRING, ENCRYPTED_STRING, DOUBLE, LONG, BOOLEAN and DATE. The format for the date is yyyy-MM-dd'T'HH:mm:ssZ. Setting a property to null will remove the property.", "operationId" : "setProperties_5", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "400" : { "description" : "Request malformed or invalid" }, "404" : { "description" : "Tenant not found" }, "500" : { "description" : "Server error" } }, "summary" : "Sets the properties for the given id.", "tags" : [ "Tenants" ] } }, "/api/rest/tenants/{id}/properties/{key}" : { "delete" : { "description" : "Note: Deleting multiple properties is possible by using the PUT method with null as values.", "operationId" : "deleteProperties_5", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "no content" }, "404" : { "description" : "Tenant or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the property entry for the given id and key.", "tags" : [ "Tenants" ] }, "get" : { "operationId" : "getProperty_5", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/Property" } } }, "description" : "OK" }, "404" : { "description" : "Tenant or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Returns the value of the property with the given id and key.", "tags" : [ "Tenants" ] } }, "/api/rest/textmodules/textmodulefirstlevelgroups" : { "get" : { "operationId" : "getAllowedTextModuleFirstLevelGroups", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { " 200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupResponse" } } } }, "description" : "OK" }, " 500" : { "description" : "Server error" } }, "summary" : "Shows all allowed text module first level groups for the current user.", "tags" : [ "Textmodules" ] }, "post" : { "description" : "Parameter name is required.", "operationId" : "createTextModuleFirstLevelGroup", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupRequest" } } } }, "responses" : { " 201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupResponse" } } }, "description" : "Created" }, " 400" : { "description" : "Request malformed" }, " 403" : { "description" : "User not allowed to create new text module first level groups." }, " 500" : { "description" : "Server error" } }, "summary" : "Creates a new text module first level group.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmodulefirstlevelgroups/{id}" : { "delete" : { "operationId" : "deleteTextModuleFirstLevelGroup", "parameters" : [ { "description" : "The id of the text module first level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { " 204" : { "description" : "No Content" }, " 403" : { "description" : "User not allowed to delete a text module first level group." }, " 404" : { "description" : "text module first level group not found" }, " 500" : { "description" : "Server error" } }, "summary" : "Deletes the text module first level group with the given id if the user is allowed to see this text module first level group.", "tags" : [ "Textmodules" ] }, "get" : { "operationId" : "getTextModuleFirstLevelGroup", "parameters" : [ { "description" : "The id of the text module first level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { " 200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupResponse" } } }, "description" : "OK" }, " 403" : { "description" : "User not assigned to this text module first level group." }, " 404" : { "description" : "text module first level group not found" }, " 500" : { "description" : "Server error" } }, "summary" : "Shows the text module first level group with the given id if the user is allowed to see this text module first level group.", "tags" : [ "Textmodules" ] }, "put" : { "operationId" : "updateTextModuleFirstLevelGroup", "parameters" : [ { "description" : "The id of the text module first level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupRequest" } } } }, "responses" : { " 200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupResponse" } } }, "description" : "OK" }, " 403" : { "description" : "User not allowed to update a text module first level group." }, " 404" : { "description" : "text module first level group not found" }, " 500" : { "description" : "Server error" } }, "summary" : "Updates the text module first level group with the given id if the user is allowed to see this text module first level group.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmodulefirstlevelgroups/{id}/assignedcategories" : { "get" : { "operationId" : "getAssignedCategories_3", "parameters" : [ { "description" : "The id of the text module first level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { " 200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, " 403" : { "description" : "User not assigned to this text module first level group." }, " 404" : { "description" : "text module first level group not found" }, " 500" : { "description" : "Server error" } }, "summary" : "Shows the assigned categories of the text module first level group with the given id if the user is allowed to see this text module first level group.", "tags" : [ "Textmodules" ] }, "put" : { "operationId" : "addAssignedCategory_3", "parameters" : [ { "description" : "The id of the text module first level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssignedCategoryRequest" } } } } }, "responses" : { " 200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, " 400" : { "description" : "No categories specified." }, " 403" : { "description" : "User not allowed to update a text module first level group." }, " 404" : { "description" : "Text module first level group or category not found" }, " 500" : { "description" : "Server error" } }, "summary" : "Assigns the categories to this text module first level group if the user is allowed to see this text module first level group.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmodulefirstlevelgroups/{id}/assignedcategories/{categoryId}" : { "delete" : { "operationId" : "removeAssignedCategory_3", "parameters" : [ { "description" : "The id of the text module first level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The id of the category to remove", "in" : "path", "name" : "categoryId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { " 204" : { "description" : "No Content" }, " 403" : { "description" : "User not allowed to remove a category assignment of this text module first level group." }, " 404" : { "description" : "Text module first level group or category not found" }, " 500" : { "description" : "Server error" } }, "summary" : "Removes the assigned category from this text module first level group.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmodulefirstlevelgroups/{id}/childtextmodulenodes" : { "get" : { "operationId" : "getChildTextModuleNodes", "parameters" : [ { "description" : "The id of the text module first level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { " 200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleNodeResponse" } } } }, "description" : "OK" }, " 403" : { "description" : "User not assigned to this text module first level group." }, " 404" : { "description" : "text module first level group not found" }, " 500" : { "description" : "Server error" } }, "summary" : "Shows the child text module nodes of the text module first level group with the given id if the user is allowed to see this text module first level group.", "tags" : [ "Textmodules" ] }, "post" : { "operationId" : "setChildTextModuleNodes", "parameters" : [ { "description" : "The id of the text module first level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleNodeRequest" } } } } }, "responses" : { " 200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleNodeResponse" } } } }, "description" : "OK" }, " 403" : { "description" : "User not allowed to update a text module first level group." }, " 404" : { "description" : "Text module first level group or text module not found" }, " 500" : { "description" : "Server error" } }, "summary" : "Changes the child text module nodes of this text module first level group if the user is allowed to see this text module first level group.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmoduleroot" : { "get" : { "operationId" : "getTextModuleRoot", "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleRootResponse" } } }, "description" : "OK" }, "404" : { "description" : "text module root not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the text module root if the user is allowed to see the text module root.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmoduleroot/childtextmodulefirstlevelgroups" : { "get" : { "operationId" : "getChildTextModuleFirstLevelGroups", "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupResponse" } } } }, "description" : "OK" }, "404" : { "description" : "text module root not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the child text module first level groups of the text module root if the user is allowed to see the text module root.", "tags" : [ "Textmodules" ] }, "post" : { "operationId" : "setChildTextModuleFirstLevelGroups", "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not allowed to update the text module root." }, "404" : { "description" : "text module root not found" }, "500" : { "description" : "Server error" } }, "summary" : "Changes the child text module first level groups of the text module root if the user is allowed to see the text module root.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmodules" : { "get" : { "operationId" : "getAllowedTextModules", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all allowed text modules for the current user.", "tags" : [ "Textmodules" ] }, "post" : { "description" : "Parameter name is required.", "operationId" : "createTextModule", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleRequest" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User not allowed to create new text modules." }, "500" : { "description" : "Server error" } }, "summary" : "Creates a new text module.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmodules/{id}" : { "delete" : { "operationId" : "deleteTextModule", "parameters" : [ { "description" : "The id of the text module", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to delete a text module." }, "404" : { "description" : "text module not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the text module with the given id if the user is allowed to see this text module.", "tags" : [ "Textmodules" ] }, "get" : { "operationId" : "getTextModule", "parameters" : [ { "description" : "The id of the text module", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this text module." }, "404" : { "description" : "text module not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the text module with the given id if the user is allowed to see this text module.", "tags" : [ "Textmodules" ] }, "put" : { "operationId" : "updateTextModule", "parameters" : [ { "description" : "The id of the text module", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleRequest" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not allowed to update a text module." }, "404" : { "description" : "text module not found" }, "500" : { "description" : "Server error" } }, "summary" : "Updates the text module with the given id if the user is allowed to see this text module.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmodules/{id}/parenttextmodulefirstlevelgroups" : { "get" : { "operationId" : "getParentTextModuleFirstLevelGroups", "parameters" : [ { "description" : "The id of the text module", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleFirstLevelGroupResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this text module." }, "404" : { "description" : "text module not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the parent text module first level groups of the text module with the given id if the user is allowed to see this text module.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmodules/{id}/parenttextmodulesecondlevelgroups" : { "get" : { "operationId" : "getParentTextModuleSecondLevelGroups", "parameters" : [ { "description" : "The id of the text module", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleSecondLevelGroupResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this text module." }, "404" : { "description" : "text module not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the parent text module second level groups of the text module with the given id if the user is allowed to see this text module.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmodulesecondlevelgroups" : { "get" : { "operationId" : "getAllowedTextModuleSecondLevelGroups", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleSecondLevelGroupResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all allowed text module second level groups for the current user.", "tags" : [ "Textmodules" ] }, "post" : { "description" : "Parameter name and parentId are required.", "operationId" : "createTextModuleSecondLevelGroup", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleSecondLevelGroupRequest" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleSecondLevelGroupResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User not allowed to create new text module second level groups." }, "500" : { "description" : "Server error" } }, "summary" : "Creates a new text module second level group.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmodulesecondlevelgroups/{id}" : { "delete" : { "operationId" : "deleteTextModuleSecondLevelGroup", "parameters" : [ { "description" : "The id of the text module second level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to delete a text module second level group." }, "404" : { "description" : "text module second level group not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the text module second level group with the given id if the user is allowed to see this text module second level group.", "tags" : [ "Textmodules" ] }, "get" : { "operationId" : "getTextModuleSecondLevelGroup", "parameters" : [ { "description" : "The id of the text module second level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleSecondLevelGroupResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this text module second level group." }, "404" : { "description" : "text module second level group not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the text module second level group with the given id if the user is allowed to see this text module second level group.", "tags" : [ "Textmodules" ] }, "put" : { "operationId" : "updateTextModuleSecondLevelGroup", "parameters" : [ { "description" : "The id of the text module second level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleSecondLevelGroupRequest" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TextModuleSecondLevelGroupResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not allowed to update a text module second level group." }, "404" : { "description" : "text module second level group not found" }, "500" : { "description" : "Server error" } }, "summary" : "Updates the text module second level group with the given id if the user is allowed to see this text module second level group.", "tags" : [ "Textmodules" ] } }, "/api/rest/textmodules/textmodulesecondlevelgroups/{id}/childtextmodules" : { "get" : { "operationId" : "getChildTextModules", "parameters" : [ { "description" : "The id of the text module second level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this text module second level group." }, "404" : { "description" : "text module second level group not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the child text modules of the text module second level group with the given id if the user is allowed to see this text module second level group.", "tags" : [ "Textmodules" ] }, "post" : { "operationId" : "setChildTextModules", "parameters" : [ { "description" : "The id of the text module second level group", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TextModuleResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not allowed to update a text module second level group." }, "404" : { "description" : "Text module second level group or text module not found" }, "500" : { "description" : "Server error" } }, "summary" : "Changes the child text module of this text module second level group if the user is allowed to see this text module second level group.", "tags" : [ "Textmodules" ] } }, "/api/rest/transactioncodes" : { "get" : { "operationId" : "getAllowedTransactionCodes", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TransactionCodeResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all allowed transaction codes for the current user.", "tags" : [ "Transaction Codes" ] }, "post" : { "description" : "Parameter name is required.", "operationId" : "createTransactionCode", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionCodeRequest" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TransactionCodeResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User not allowed to create new transaction codes." }, "500" : { "description" : "Server error" } }, "summary" : "Creates a new transaction code.", "tags" : [ "Transaction Codes" ] } }, "/api/rest/transactioncodes/{id}" : { "delete" : { "operationId" : "deleteTransactionCode", "parameters" : [ { "description" : "The id of the transaction code", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to delete a transaction code." }, "404" : { "description" : "Transaction code not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the transaction code with the given id if the user is allowed to see this transaction code. The transaction code is only marked as deleted.", "tags" : [ "Transaction Codes" ] }, "get" : { "operationId" : "getTransactionCode", "parameters" : [ { "description" : "The id of the transaction code", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/TransactionCodeResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this transaction code." }, "404" : { "description" : "Transaction code not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the transaction code with the given id if the user is allowed to see this transaction code.", "tags" : [ "Transaction Codes" ] }, "put" : { "operationId" : "updateTransactionCode", "parameters" : [ { "description" : "The id of the transaction code", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionCodeRequest" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryResponse" } } }, "description" : "OK" }, "403" : { "description" : "User not allowed to update a transaction code." }, "404" : { "description" : "Transaction code not found" }, "500" : { "description" : "Server error" } }, "summary" : "Updates the transaction code with the given id if the user is allowed to see this transaction code.", "tags" : [ "Transaction Codes" ] } }, "/api/rest/transactioncodes/{id}/assignedcategories" : { "get" : { "operationId" : "getAssignedCategories_4", "parameters" : [ { "description" : "The id of the transaction code", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, "403" : { "description" : "User not assigned to this transaction code." }, "404" : { "description" : "Transaction code not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the assigned categories of the transaction code with the given id if the user is allowed to see this transaction code.", "tags" : [ "Transaction Codes" ] }, "put" : { "operationId" : "addAssignedCategory_4", "parameters" : [ { "description" : "The id of the transaction code", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssignedCategoryRequest" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "description" : "OK" }, "400" : { "description" : "No categories specified or one category is already assigned." }, "403" : { "description" : "User not allowed to update a transaction code." }, "404" : { "description" : "Transaction code or category not found" }, "500" : { "description" : "Server error" } }, "summary" : "Assigns the categories to this transaction code if the user is allowed to see this transaction code.", "tags" : [ "Transaction Codes" ] } }, "/api/rest/transactioncodes/{id}/assignedcategories/{categoryId}" : { "delete" : { "operationId" : "removeAssignedCategory_4", "parameters" : [ { "description" : "The id of the transaction code", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The id of the category to remove", "in" : "path", "name" : "categoryId", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User not allowed to remove a category assignment of this transaction code." }, "404" : { "description" : "Transaction code or category not found or not assigned" }, "500" : { "description" : "Server error" } }, "summary" : "Removes the assigned category from this transaction code.", "tags" : [ "Transaction Codes" ] } }, "/api/rest/transactioncodes/{id}/properties" : { "get" : { "operationId" : "getTransactionCodeProperties", "parameters" : [ { "description" : "The transaction code id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "404" : { "description" : "Transaction code not found" }, "500" : { "description" : "Server error" } }, "summary" : "Shows the Transaction codes properties for the given id.", "tags" : [ "Transaction Codes" ] }, "put" : { "description" : "Possible types are: STRING, ENCRYPTED_STRING, DOUBLE, LONG, BOOLEAN and DATE. The format for the date is yyyy-MM-dd'T'HH:mm:ssZ. Setting a property to null will remove the property.", "operationId" : "setProperties_6", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "400" : { "description" : "Request malformed or invalid" }, "404" : { "description" : "Transaction code not found" }, "500" : { "description" : "Server error" } }, "summary" : "Sets the properties for the given id.", "tags" : [ "Transaction Codes" ] } }, "/api/rest/transactioncodes/{id}/properties/{key}" : { "delete" : { "description" : "Note: Deleting multiple properties is possible by using the PUT method with null as values.", "operationId" : "deleteProperties_6", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "no content" }, "400" : { "description" : "Request malformed or invalid" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Category or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the property entry for the given id and key.", "tags" : [ "Transaction Codes" ] }, "get" : { "operationId" : "getProperty_6", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "Category or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Returns the value of the property with the given id and key.", "tags" : [ "Transaction Codes" ] } }, "/api/rest/users" : { "get" : { "operationId" : "getUsers", "parameters" : [ { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Parameter returns the online-users which are filtered based on a given categoryId.", "in" : "query", "name" : "categoryId", "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "Parameter returns the online-users which are filtered based on a given groupId.", "in" : "query", "name" : "groupId", "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "Parameter returns the online-users which are filtered based on a given deviceId.", "in" : "query", "name" : "deviceId", "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "Parameter returns the online-users which are filtered based on a given deviceState.", "in" : "query", "name" : "deviceState", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserResponse" } } } }, "description" : "OK" }, "500" : { "description" : "Server error" } }, "summary" : "Shows all visible users.", "tags" : [ "Users" ] }, "post" : { "description" : "Parameter name, username, password and address are required.", "operationId" : "createUser", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserRequest" } } } }, "responses" : { "201" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/UserResponse" } } }, "description" : "Created" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User is not allowed to execute this operation" }, "500" : { "description" : "Server error" } }, "summary" : "Creates a new user.", "tags" : [ "Users" ] } }, "/api/rest/users/{id}" : { "delete" : { "operationId" : "deleteUser", "parameters" : [ { "description" : "The user id, username or 'me'", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "User not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the user. The user is only marked as deleted.", "tags" : [ "Users" ] }, "get" : { "operationId" : "getUser", "parameters" : [ { "description" : "The user id, username or 'me'", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/UserResponse" } } }, "description" : "OK" }, "401" : { "description" : "User not authorized." }, "404" : { "description" : "User not found." }, "500" : { "description" : "Server error" } }, "summary" : "Shows the user information.", "tags" : [ "Users" ] }, "put" : { "operationId" : "updateUser", "parameters" : [ { "description" : "The user id, username or 'me'", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserRequest" } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/UserResponse" } } }, "description" : "OK" }, "400" : { "description" : "Request malformed" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "User not found" }, "500" : { "description" : "Server error" } }, "summary" : "Updates the user.", "tags" : [ "Users" ] } }, "/api/rest/users/{id}/groups" : { "get" : { "operationId" : "getUserGroups", "parameters" : [ { "description" : "The user id, username or 'me'", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupResponse" } } } }, "description" : "OK" }, "401" : { "description" : "User not authorized." }, "404" : { "description" : "User not found." }, "500" : { "description" : "Server error" } }, "summary" : "Shows the assigned groups for the given user.", "tags" : [ "Users" ] } }, "/api/rest/users/{id}/languageskills" : { "get" : { "operationId" : "getLanguageSkills", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "User not found" }, "500" : { "description" : "Server error" } }, "summary" : "Returns a list of all the user's language skills", "tags" : [ "Users" ] }, "put" : { "operationId" : "addLanguageSkills", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "responses" : { "200" : { "description" : "OK" }, "400" : { "description" : "Missing or invalid language code specified" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "User not found" }, "500" : { "description" : "Server error" } }, "summary" : "Adds language skills to the user", "tags" : [ "Users" ] } }, "/api/rest/users/{id}/languageskills/{languageCode}" : { "delete" : { "operationId" : "removeLanguageSkills", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The language code to remove", "in" : "path", "name" : "languageCode", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "User not found" }, "500" : { "description" : "Server error" } }, "summary" : "Removes a specific language skill of the user", "tags" : [ "Users" ] } }, "/api/rest/users/{id}/properties" : { "get" : { "operationId" : "getUserProperties", "parameters" : [ { "description" : "The user id, username or 'me'", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "401" : { "description" : "User not authorized." }, "404" : { "description" : "User not found." }, "500" : { "description" : "Server error" } }, "summary" : "Shows the user information.", "tags" : [ "Users" ] }, "put" : { "description" : "Possible types are: STRING, ENCRYPTED_STRING, DOUBLE, LONG, BOOLEAN and DATE. The format for the date is yyyy-MM-dd'T'HH:mm:ssZ. Setting a property to null will remove the property.", "operationId" : "setProperties_7", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } } } } }, "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/PropertyListResponse" } } }, "description" : "OK" }, "400" : { "description" : "Request malformed or invalid" }, "401" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "User not found" }, "500" : { "description" : "Server error" } }, "summary" : "Sets the properties for the given id.", "tags" : [ "Users" ] } }, "/api/rest/users/{id}/properties/{key}" : { "delete" : { "description" : "Note: Deleting multiple properties is possible by using the PUT method with null as values.", "operationId" : "deleteProperties_7", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "no content" }, "401" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "User or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Deletes the property entry for the given id and key.", "tags" : [ "Users" ] }, "get" : { "operationId" : "getProperty_7", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The key", "in" : "path", "name" : "key", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "$ref" : "#/components/schemas/Property" } } }, "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "User or property not found" }, "500" : { "description" : "Server error" } }, "summary" : "Returns the value of the property with the given id and key.", "tags" : [ "Users" ] } }, "/api/rest/users/{id}/routingtags" : { "get" : { "operationId" : "getRoutingTags_1", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "User not found" }, "500" : { "description" : "Server error" } }, "summary" : "Returns all of the user's routing tags", "tags" : [ "Users" ] }, "put" : { "operationId" : "addRoutingTags", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "responses" : { "200" : { "description" : "OK" }, "400" : { "description" : "Missing or invalid routing tag specified" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "User not found" }, "500" : { "description" : "Server error" } }, "summary" : "Adds routing tags to the user", "tags" : [ "Users" ] } }, "/api/rest/users/{id}/routingtags/{routingTagName}" : { "delete" : { "operationId" : "removeRoutingTags", "parameters" : [ { "description" : "The id", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The language code to remove", "in" : "path", "name" : "routingTagName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "User is not allowed to execute this operation" }, "404" : { "description" : "User not found" }, "500" : { "description" : "Server error" } }, "summary" : "Removes a specific routing tag of the user", "tags" : [ "Users" ] } }, "/api/rest/users/{id}/visibleCategories" : { "get" : { "operationId" : "getUserVisibleCategories", "parameters" : [ { "description" : "The user id, username or 'me'", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserResponse" } } } }, "description" : "OK" }, "401" : { "description" : "User not authorized." }, "404" : { "description" : "User not found." }, "500" : { "description" : "Server error" } }, "summary" : "Shows the visible categories for a user.", "tags" : [ "Users" ] } }, "/api/rest/users/{id}/visibleMandators" : { "get" : { "operationId" : "getUserMandators", "parameters" : [ { "description" : "The user id, username or 'me'", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Parameter for limiting the result", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/vnd.novomind.iagent-v2+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TenantResponse" } } } }, "description" : "OK" }, "401" : { "description" : "User not authorized." }, "404" : { "description" : "User not found." }, "500" : { "description" : "Server error" } }, "summary" : "Shows the assigned mandators for the user.", "tags" : [ "Users" ] } } }, "components" : { "schemas" : { "AccountExtendedResponse" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "The unique email address of the account.", "example" : "info@example.org" }, "alternativeOutgoingAccountId" : { "type" : "integer", "format" : "int64", "description" : "this entity id of the alternative outgoing account", "example" : 301 }, "channel" : { "type" : "integer", "format" : "int32", "description" : "the id of the channel", "example" : 1 }, "channelName" : { "type" : "string", "description" : "The name of the channel. Use either one of the standard channels EMAIL, LETTER, FAX, SMS or any of the custom channels in the system", "example" : "EMAIL" }, "coreId" : { "type" : "integer", "format" : "int32", "description" : "id/port of the core process used for this account" }, "deleted" : { "type" : "boolean", "description" : "flag to indicate a deleted account entity", "example" : false }, "enabled" : { "type" : "boolean", "default" : false, "description" : "is the account enabled" }, "errorCount" : { "type" : "integer", "format" : "int32", "description" : "amount of errors since the last reset" }, "host" : { "type" : "string", "deprecated" : true, "description" : "the hostname for build-in protocol types", "example" : "imap.example.org" }, "icon" : { "type" : "string", "description" : "name of the used icon" }, "id" : { "type" : "integer", "format" : "int64", "description" : "the entity id of this account", "example" : 300 }, "lastMailProcessed" : { "type" : "string", "format" : "date-time", "description" : "timestamp of the last mail processing" }, "lastPolling" : { "type" : "string", "format" : "date-time", "description" : "timestamp of the last polling" }, "links" : { "type" : "array", "description" : "Array of Links to related actions or entities", "items" : { "$ref" : "#/components/schemas/AccountLink" } }, "logFileName" : { "type" : "string", "description" : "name of the incoming logfile" }, "mailCount" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string", "description" : "The unique name of the account", "example" : "myAccountName" }, "outgoing_enabled" : { "type" : "boolean", "deprecated" : true, "description" : "same as sendAllowed. Included for compatibility reasons." }, "outgoing_errorCount" : { "type" : "integer", "format" : "int32", "description" : "amount of outgoing errors since the last reset" }, "outgoing_last_mail_processed" : { "type" : "string", "format" : "date-time", "description" : "timestamp of the last outgoing mail processing" }, "outgoing_last_polling" : { "type" : "string", "format" : "date-time", "description" : "timestamp of the last outgoing polling" }, "outgoing_log_file_name" : { "type" : "string", "description" : "name of the outgoing logfile" }, "outgoing_mailcount" : { "type" : "integer", "format" : "int32" }, "outgoing_running" : { "type" : "boolean", "description" : "is the outgoing account running" }, "persistent" : { "type" : "boolean", "description" : "flag to indicate a persistent account entity", "example" : true }, "protocol" : { "type" : "string", "description" : "The name of the protocol. Use either one of the build in legacy protocols POP3, POP3S, IMAP, IMAPS, FILE or any of the custom channels in the system (e.g. NOVOMIND.IMAP)", "example" : "IMAPS" }, "running" : { "type" : "boolean", "description" : "is the account running" }, "sendAllowed" : { "type" : "boolean", "description" : "is the send functionality of the account allowed", "example" : false }, "smtpConnectTimeout" : { "type" : "integer", "format" : "int32", "deprecated" : true, "description" : "timeout (in ms) when connecting the host using the build-in smtp protocol" }, "smtpHost" : { "type" : "string", "deprecated" : true, "description" : "the smtp hostname for build-in smtp protocol", "example" : "smtp.example.org" }, "smtpIOTimeout" : { "type" : "integer", "format" : "int32", "deprecated" : true, "description" : "timeout of each response during the smtp connection using the build-in smtp protocol" }, "smtpPort" : { "type" : "integer", "format" : "int32", "deprecated" : true, "description" : "port used when connecting the smtp host using the build-in smtp protocol" }, "smtpRetryCount" : { "type" : "integer", "format" : "int32" }, "smtpRetryInterval" : { "type" : "integer", "format" : "int32" }, "smtpUser" : { "type" : "string", "deprecated" : true, "description" : "the smtp username for build-in smtp protocol", "example" : "johndoe" }, "startTLSRequired" : { "type" : "boolean", "deprecated" : true, "description" : "enforce usage of STARTTLS when connecting the host using build-in protocols" }, "systemAccount" : { "type" : "boolean", "deprecated" : true, "description" : "true if this is type not INCOMING" }, "tenantId" : { "type" : "integer", "format" : "int64", "description" : "the entity id of the tenant", "example" : 73 }, "type" : { "type" : "string", "description" : "The type of the account. Use INCOMING for incoming accounts and OUTGOING or EXTERNAL_REPLY for system accounts", "enum" : [ "INCOMING", "OUTGOING", "EXTERNAL_REPLY" ] }, "useSSL" : { "type" : "boolean", "deprecated" : true, "description" : "use SSL/TLS to connect to the host when using build-in protocols" }, "useStartTLS" : { "type" : "boolean", "deprecated" : true, "description" : "use STARTTLS when connecting the host using build-in protocols" }, "user" : { "type" : "string", "deprecated" : true, "description" : "the username for build-in protocol types", "example" : "johndoe" } }, "required" : [ "address", "channelName", "name", "protocol", "type" ] }, "AccountLink" : { "type" : "object", "description" : "Array of Links to related actions or entities", "properties" : { "href" : { "type" : "string" }, "rel" : { "type" : "string", "enum" : [ "self", "edit", "accounts.properties", "accounts.tenant", "accounts.outgoingaccount" ] } } }, "AccountPatchRequest" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "The new unique email address of the account.", "example" : "newInfo@example.org" }, "alternativeOutgoingAccountId" : { "type" : "integer", "format" : "int64", "description" : "the entity id of the alternative outgoing account or null to remove the outgoing account", "example" : 301, "nullable" : true }, "channelName" : { "type" : "string", "description" : "The name of the new channel. Use either one of the standard channels EMAIL, LETTER, FAX, SMS or any of the custom channels in the system", "example" : "EMAIL" }, "enabled" : { "type" : "boolean", "default" : false, "description" : "is the account enabled" }, "host" : { "type" : "string", "deprecated" : true, "description" : "the hostname for build-in protocol types", "example" : "imap.example.org" }, "name" : { "type" : "string", "description" : "The new unique name of the account", "example" : "myNewAccountName" }, "password" : { "type" : "string", "deprecated" : true, "description" : "the password for build-in protocol types" }, "protocol" : { "type" : "string", "description" : "The name of the new protocol. Use either one of the build in legacy protocols POP3, POP3S, IMAP, IMAPS, FILE or any of the custom channels in the system (e.g. NOVOMIND.IMAP)", "example" : "IMAPS" }, "sendAllowed" : { "type" : "boolean", "description" : "is the send functionality of the account allowed", "example" : false }, "smtpHost" : { "type" : "string", "deprecated" : true, "description" : "the smtp hostname for build-in smtp protocol", "example" : "smtp.example.org" }, "smtpPassword" : { "type" : "string", "deprecated" : true, "description" : "the smtp password for build-in smtp protocol" }, "smtpUser" : { "type" : "string", "deprecated" : true, "description" : "the smtp username for build-in smtp protocol", "example" : "johndoe" }, "tenantId" : { "type" : "integer", "format" : "int64", "description" : "the entity id of the tenant or null to remove the tenant", "example" : 73, "nullable" : true }, "user" : { "type" : "string", "deprecated" : true, "description" : "the username for build-in protocol types", "example" : "johndoe" } } }, "AccountRequest" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "The unique email address of the account.", "example" : "info@example.org" }, "alternativeOutgoingAccountId" : { "type" : "integer", "format" : "int64", "description" : "this entity id of the alternative outgoing account", "example" : 301 }, "channelName" : { "type" : "string", "description" : "The name of the channel. Use either one of the standard channels EMAIL, LETTER, FAX, SMS or any of the custom channels in the system", "example" : "EMAIL" }, "enabled" : { "type" : "boolean", "default" : false, "description" : "is the account enabled" }, "host" : { "type" : "string", "deprecated" : true, "description" : "the hostname for build-in protocol types", "example" : "imap.example.org" }, "name" : { "type" : "string", "description" : "The unique name of the account", "example" : "myAccountName" }, "password" : { "type" : "string", "deprecated" : true, "description" : "the password for build-in protocol types" }, "protocol" : { "type" : "string", "description" : "The name of the protocol. Use either one of the build in legacy protocols POP3, POP3S, IMAP, IMAPS, FILE or any of the custom channels in the system (e.g. NOVOMIND.IMAP)", "example" : "IMAPS" }, "sendAllowed" : { "type" : "boolean", "description" : "is the send functionality of the account allowed", "example" : false }, "smtpHost" : { "type" : "string", "deprecated" : true, "description" : "the smtp hostname for build-in smtp protocol", "example" : "smtp.example.org" }, "smtpPassword" : { "type" : "string", "deprecated" : true, "description" : "the smtp password for build-in smtp protocol" }, "smtpUser" : { "type" : "string", "deprecated" : true, "description" : "the smtp username for build-in smtp protocol", "example" : "johndoe" }, "tenantId" : { "type" : "integer", "format" : "int64", "description" : "the entity id of the tenant", "example" : 73 }, "type" : { "type" : "string", "description" : "The type of the account. Use INCOMING for incoming accounts and OUTGOING or EXTERNAL_REPLY for system accounts", "enum" : [ "INCOMING", "OUTGOING", "EXTERNAL_REPLY" ] }, "user" : { "type" : "string", "deprecated" : true, "description" : "the username for build-in protocol types", "example" : "johndoe" } }, "required" : [ "address", "channelName", "name", "protocol", "type" ] }, "AccountResponse" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "The unique email address of the account.", "example" : "info@example.org" }, "alternativeOutgoingAccountId" : { "type" : "integer", "format" : "int64", "description" : "this entity id of the alternative outgoing account", "example" : 301 }, "channel" : { "type" : "integer", "format" : "int32", "description" : "the id of the channel", "example" : 1 }, "channelName" : { "type" : "string", "description" : "The name of the channel. Use either one of the standard channels EMAIL, LETTER, FAX, SMS or any of the custom channels in the system", "example" : "EMAIL" }, "enabled" : { "type" : "boolean", "default" : false, "description" : "is the account enabled" }, "host" : { "type" : "string", "deprecated" : true, "description" : "the hostname for build-in protocol types", "example" : "imap.example.org" }, "id" : { "type" : "integer", "format" : "int64", "description" : "the entity id of this account", "example" : 300 }, "links" : { "type" : "array", "description" : "Array of Links to related actions or entities", "items" : { "$ref" : "#/components/schemas/AccountLink" } }, "name" : { "type" : "string", "description" : "The unique name of the account", "example" : "myAccountName" }, "protocol" : { "type" : "string", "description" : "The name of the protocol. Use either one of the build in legacy protocols POP3, POP3S, IMAP, IMAPS, FILE or any of the custom channels in the system (e.g. NOVOMIND.IMAP)", "example" : "IMAPS" }, "sendAllowed" : { "type" : "boolean", "description" : "is the send functionality of the account allowed", "example" : false }, "smtpHost" : { "type" : "string", "deprecated" : true, "description" : "the smtp hostname for build-in smtp protocol", "example" : "smtp.example.org" }, "smtpUser" : { "type" : "string", "deprecated" : true, "description" : "the smtp username for build-in smtp protocol", "example" : "johndoe" }, "tenantId" : { "type" : "integer", "format" : "int64", "description" : "the entity id of the tenant", "example" : 73 }, "type" : { "type" : "string", "description" : "The type of the account. Use INCOMING for incoming accounts and OUTGOING or EXTERNAL_REPLY for system accounts", "enum" : [ "INCOMING", "OUTGOING", "EXTERNAL_REPLY" ] }, "user" : { "type" : "string", "deprecated" : true, "description" : "the username for build-in protocol types", "example" : "johndoe" } }, "required" : [ "address", "channelName", "name", "protocol", "type" ] }, "AgentGroupRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "name" : { "type" : "string" }, "parentId" : { "type" : "integer", "format" : "int64" } } }, "AgentGroupResponse" : { "type" : "object", "properties" : { "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int64" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" } } }, "AgentInfoResponse" : { "type" : "object", "properties" : { "agentCount" : { "type" : "integer", "format" : "int32" }, "avgServiceLevel" : { "type" : "integer", "format" : "int32" }, "onlineAgentCount" : { "type" : "integer", "format" : "int32" }, "onlineAgentCountCategories" : { "type" : "integer", "format" : "int32" } } }, "AssignedCategoryRequest" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" } } }, "AssignedGroupRequest" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" } } }, "AssignedPrivilegeRequest" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" } } }, "AssignedTransactionCodeRequest" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" } } }, "AssignedUserRequest" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" } } }, "AttachmentParameter" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "BusinessHourResponse" : { "type" : "object", "properties" : { "active" : { "type" : "boolean" }, "calendarId" : { "type" : "integer", "format" : "int64" }, "id" : { "type" : "integer", "format" : "int64" }, "isHoliday" : { "type" : "boolean" }, "lastEndTime" : { "type" : "integer", "format" : "int64" }, "lastStartTime" : { "type" : "integer", "format" : "int64" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" }, "timeSlots" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BusinessTimeSlotResponse" } }, "timeZone" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "dstsavings" : { "type" : "integer", "format" : "int32" }, "id" : { "type" : "string" }, "rawOffset" : { "type" : "integer", "format" : "int32" } } } } }, "BusinessTimeSlotResponse" : { "type" : "object", "properties" : { "endTime" : { "type" : "string" }, "startTime" : { "type" : "string" }, "weekDays" : { "type" : "object", "additionalProperties" : { "type" : "boolean" } } } }, "CallResponse" : { "type" : "object", "properties" : { "categoryId" : { "type" : "integer", "format" : "int64" }, "contactId" : { "type" : "integer", "format" : "int64" }, "dateEnqueued" : { "type" : "string", "format" : "date-time" }, "dateFinished" : { "type" : "string", "format" : "date-time" }, "dateFirstrouted" : { "type" : "string", "format" : "date-time" }, "dateReceived" : { "type" : "string", "format" : "date-time" }, "extCallId" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int64" }, "language" : { "type" : "string" }, "locationId" : { "type" : "integer", "format" : "int64" }, "mandatorId" : { "type" : "integer", "format" : "int64" }, "orgCategoryId" : { "type" : "integer", "format" : "int64" }, "sourcePhonenumberId" : { "type" : "integer", "format" : "int64" }, "targetId" : { "type" : "string" }, "transactionCodeId" : { "type" : "integer", "format" : "int64" }, "waitingTime" : { "type" : "integer", "format" : "int64" } } }, "CategoryRequest" : { "type" : "object", "properties" : { "agentGroupId" : { "type" : "integer", "format" : "int64" }, "allowedForNewProcesses" : { "type" : "boolean" }, "allowedForPhoneTickets" : { "type" : "boolean" }, "allowedRecategorizationDestination" : { "type" : "boolean" }, "allowedRecategorizationSource" : { "type" : "boolean" }, "answerAllowed" : { "type" : "boolean" }, "autoRoutingEnabled" : { "type" : "boolean" }, "bundlingEnabled" : { "type" : "boolean" }, "chatCategory" : { "type" : "boolean" }, "clearanceRequired" : { "type" : "boolean" }, "closeAllowed" : { "type" : "boolean" }, "ctiRoutingEnabled" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "escalationCategoryId" : { "type" : "integer", "format" : "int64" }, "escalationTimeoutMillis" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "privilegedRoutingEnabled" : { "type" : "boolean" }, "serviceLevelMillis" : { "type" : "integer", "format" : "int64" }, "spellcheckRequired" : { "type" : "boolean" }, "transactionCodeRequired" : { "type" : "boolean" }, "transactionCodeRequiredCall" : { "type" : "boolean" }, "transactionCodeRequiredChat" : { "type" : "boolean" }, "transactionCodeRequiredMail" : { "type" : "boolean" } } }, "CategoryResponse" : { "type" : "object", "properties" : { "allowedForNewProcesses" : { "type" : "boolean" }, "allowedForPhoneTickets" : { "type" : "boolean" }, "allowedRecategorizationDestination" : { "type" : "boolean" }, "allowedRecategorizationSource" : { "type" : "boolean" }, "answerAllowed" : { "type" : "boolean" }, "autoRoutingEnabled" : { "type" : "boolean" }, "bundlingEnabled" : { "type" : "boolean" }, "chatCategory" : { "type" : "boolean" }, "claimCategory" : { "type" : "boolean" }, "clearanceRequired" : { "type" : "boolean" }, "closeAllowed" : { "type" : "boolean" }, "codeRequired" : { "type" : "boolean" }, "ctiRoutingEnabled" : { "type" : "boolean" }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int64" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" }, "spellcheckRequired" : { "type" : "boolean" }, "superCat" : { "type" : "boolean" }, "transactionCodeRequiredCall" : { "type" : "boolean" }, "transactionCodeRequiredChat" : { "type" : "boolean" }, "transactionCodeRequiredMail" : { "type" : "boolean" } } }, "ChatBotRequest" : { "type" : "object", "properties" : { "agentRoutingTimeout" : { "type" : "integer", "format" : "int64" }, "botRoutingTimeout" : { "type" : "integer", "format" : "int64" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "inactivityTimeout" : { "type" : "integer", "format" : "int64" }, "kbAgent" : { "type" : "string" }, "name" : { "type" : "string" }, "nickname" : { "type" : "string" }, "restUrl" : { "type" : "string" }, "routeToAgentTimeout" : { "type" : "integer", "format" : "int64" }, "sendTyping" : { "type" : "boolean" }, "tenantId" : { "type" : "integer", "format" : "int64" } } }, "ChatBotResponse" : { "type" : "object", "properties" : { "agentRoutingTimeout" : { "type" : "integer", "format" : "int64" }, "botRoutingTimeout" : { "type" : "integer", "format" : "int64" }, "categories" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" }, "uniqueItems" : true }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "integer", "format" : "int64" }, "inactivityTimeout" : { "type" : "integer", "format" : "int64" }, "kbAgent" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "messengerAccounts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MessengerAccountResponse" }, "uniqueItems" : true }, "name" : { "type" : "string" }, "nickname" : { "type" : "string" }, "restUrl" : { "type" : "string" }, "routeToAgentTimeout" : { "type" : "integer", "format" : "int64" }, "sendTyping" : { "type" : "boolean" }, "tenantId" : { "type" : "integer", "format" : "int64" } } }, "ChatPermissionModel" : { "type" : "object", "properties" : { "end" : { "type" : "string", "format" : "date-time" }, "id" : { "type" : "integer", "format" : "int64" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "note" : { "type" : "string" }, "pin" : { "type" : "string" }, "start" : { "type" : "string", "format" : "date-time" }, "ticketId" : { "type" : "integer", "format" : "int64" }, "userId" : { "type" : "integer", "format" : "int64" } } }, "ChatPermissionRequest" : { "type" : "object", "properties" : { "end" : { "type" : "string", "format" : "date-time" }, "note" : { "type" : "string" }, "start" : { "type" : "string", "format" : "date-time" }, "ticketId" : { "type" : "integer", "format" : "int64" }, "userId" : { "type" : "integer", "format" : "int64" } } }, "ChatResponse" : { "type" : "object", "properties" : { "accountId" : { "type" : "integer", "format" : "int64" }, "accountName" : { "type" : "string" }, "agent" : { "type" : "string" }, "agentAddressId" : { "type" : "integer", "format" : "int64" }, "bodyPreview" : { "type" : "array", "items" : { "type" : "string" } }, "category" : { "type" : "string" }, "channel" : { "type" : "integer", "format" : "int32" }, "channelName" : { "type" : "string" }, "contactId" : { "type" : "string" }, "contactName" : { "type" : "string" }, "endDate" : { "type" : "string", "format" : "date-time" }, "id" : { "type" : "integer", "format" : "int64" }, "startDate" : { "type" : "string", "format" : "date-time" }, "status" : { "type" : "integer", "format" : "int32" }, "transactionCode" : { "type" : "integer", "format" : "int64" } } }, "CloseParameters" : { "type" : "object", "properties" : { "transactionCodeId" : { "type" : "integer", "format" : "int64" } } }, "CtiInfoResponse" : { "type" : "object", "properties" : { "ctiEnabled" : { "type" : "boolean" }, "ctiError" : { "type" : "boolean" }, "ctiWarning" : { "type" : "boolean" } } }, "EmlParameter" : { "type" : "object", "properties" : { "accountId" : { "type" : "integer", "format" : "int64" }, "eml" : { "type" : "string", "format" : "binary" } } }, "GroupPrivilegeResponse" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" } } }, "GroupResponse" : { "type" : "object", "properties" : { "deleted" : { "type" : "boolean" }, "id" : { "type" : "integer", "format" : "int64" }, "isSystemGroup" : { "type" : "boolean" }, "name" : { "type" : "string" }, "privileges" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupPrivilegeResponse" }, "uniqueItems" : true } } }, "HealthInfoResponse" : { "type" : "object", "properties" : { "benchmark" : { "type" : "integer", "format" : "int32" }, "databaseAccessTime" : { "type" : "integer", "format" : "int32" }, "freeMemoryMB" : { "type" : "integer", "format" : "int32" }, "maxMemoryMB" : { "type" : "integer", "format" : "int32" }, "outboxMailCount" : { "type" : "integer", "format" : "int32" }, "processors" : { "type" : "integer", "format" : "int32" }, "totalMemoryMB" : { "type" : "integer", "format" : "int32" } } }, "HolidayListResponse" : { "type" : "object", "properties" : { "holidays" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HolidayResponse" } }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" } } }, "HolidayResponse" : { "type" : "object", "properties" : { "end" : { "type" : "string", "format" : "date-time" }, "isCustomHoliday" : { "type" : "boolean" }, "name" : { "type" : "string" }, "start" : { "type" : "string", "format" : "date-time" } } }, "LinkResponse" : { "type" : "object", "properties" : { "href" : { "type" : "string" }, "rel" : { "type" : "string" } } }, "LocationRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "name" : { "type" : "string" }, "timeZone" : { "type" : "string" }, "uid" : { "type" : "string" } } }, "LocationResponse" : { "type" : "object", "properties" : { "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int64" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" }, "timeZone" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "dstsavings" : { "type" : "integer", "format" : "int32" }, "id" : { "type" : "string" }, "rawOffset" : { "type" : "integer", "format" : "int32" } } }, "uid" : { "type" : "string" } } }, "MailParameters" : { "type" : "object", "properties" : { "accountId" : { "type" : "integer", "format" : "int32" }, "attachments" : { "type" : "array", "items" : { "type" : "string" } }, "body" : { "type" : "string" }, "category" : { "type" : "string" }, "cause" : { "type" : "integer", "format" : "int32" }, "claimId" : { "type" : "integer", "format" : "int64" }, "contactId" : { "type" : "integer", "format" : "int64" }, "editTime" : { "type" : "integer", "format" : "int64" }, "from" : { "type" : "string" }, "headers" : { "$ref" : "#/components/schemas/MailParametersHeaders" }, "html" : { "type" : "boolean" }, "incomingChannel" : { "type" : "integer", "format" : "int32" }, "languageCode" : { "type" : "string" }, "locationId" : { "type" : "integer", "format" : "int64" }, "mode" : { "type" : "integer", "format" : "int32" }, "processId" : { "type" : "integer", "format" : "int64" }, "properties" : { "$ref" : "#/components/schemas/MailParametersProperties" }, "refId" : { "type" : "string" }, "status" : { "type" : "integer", "format" : "int32" }, "subject" : { "type" : "string" }, "template" : { "type" : "string" }, "transactionCodeId" : { "type" : "integer", "format" : "int64" } } }, "MailParametersHeaders" : { "type" : "object", "example" : { "header1" : "string", "header2" : "string", "header3" : "string" } }, "MailParametersProperties" : { "type" : "object", "example" : { "property1" : "string", "property2" : "string", "property3" : "string" } }, "MailResponse" : { "type" : "object", "properties" : { "accountAddress" : { "type" : "string" }, "accountId" : { "type" : "integer", "format" : "int32" }, "category" : { "type" : "string" }, "cause" : { "type" : "integer", "format" : "int32" }, "completionCode" : { "type" : "integer", "format" : "int64" }, "completionCodeName" : { "type" : "string" }, "dateProcessed" : { "type" : "string", "format" : "date-time" }, "dateReceived" : { "type" : "string", "format" : "date-time" }, "emailId" : { "type" : "integer", "format" : "int64" }, "from" : { "type" : "string" }, "hasAttachment" : { "type" : "boolean" }, "hasInlineAttachment" : { "type" : "boolean" }, "incomingChannel" : { "type" : "integer", "format" : "int32" }, "languageCode" : { "type" : "string" }, "lastClerkAddress" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "outgoingChannel" : { "type" : "integer", "format" : "int32" }, "processId" : { "type" : "integer", "format" : "int64" }, "refId" : { "type" : "string" }, "status" : { "type" : "integer", "format" : "int32" }, "subProcess" : { "type" : "boolean" }, "subject" : { "type" : "string" }, "target" : { "type" : "string" } } }, "MailboxEntry" : { "type" : "object", "properties" : { "mail" : { "$ref" : "#/components/schemas/MailResponse" }, "metadata" : { "$ref" : "#/components/schemas/MailboxMetaData" } } }, "MailboxMetaData" : { "type" : "object", "properties" : { "channelIcon" : { "type" : "string" }, "slc" : { "type" : "string" } } }, "MailboxResponse" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MailboxEntry" } }, "inboxName" : { "type" : "string" }, "mailCount" : { "type" : "integer", "format" : "int32" } } }, "MessengerAccountResponse" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" } } }, "MonitoringAccountResponse" : { "type" : "object", "properties" : { "address" : { "type" : "string" }, "errorCount" : { "type" : "integer", "format" : "int32" }, "host" : { "type" : "string" }, "lastMailProcessed" : { "type" : "string", "format" : "date-time" }, "lastPolling" : { "type" : "string", "format" : "date-time" }, "mailCount" : { "type" : "integer", "format" : "int32" }, "mandator" : { "$ref" : "#/components/schemas/TenantInfo" }, "name" : { "type" : "string" }, "protocol" : { "type" : "string" }, "running" : { "type" : "boolean" }, "smtpConnectTimeout" : { "type" : "integer", "format" : "int32" }, "smtpHost" : { "type" : "string" }, "smtpIOTimeout" : { "type" : "integer", "format" : "int32" }, "smtpPort" : { "type" : "integer", "format" : "int32" }, "smtpRetryCount" : { "type" : "integer", "format" : "int32" }, "smtpRetryInterval" : { "type" : "integer", "format" : "int32" }, "smtpUser" : { "type" : "string" }, "startTLSRequired" : { "type" : "boolean" }, "useSSL" : { "type" : "boolean" }, "useStartTLS" : { "type" : "boolean" }, "user" : { "type" : "string" } } }, "NewCallParameters" : { "type" : "object", "properties" : { "account" : { "type" : "integer", "format" : "int64" }, "attachments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AttachmentParameter" } }, "bcc" : { "type" : "string" }, "category" : { "type" : "string" }, "cc" : { "type" : "string" }, "channel" : { "type" : "integer", "format" : "int32" }, "contact" : { "type" : "integer", "format" : "int64" }, "crmData" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } }, "customer" : { "type" : "string" }, "language" : { "type" : "string" }, "options" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } }, "processId" : { "type" : "integer", "format" : "int64" }, "refId" : { "type" : "string" }, "subject" : { "type" : "string" }, "template" : { "type" : "string" }, "user" : { "type" : "string" } } }, "NewCaseParameters" : { "type" : "object", "properties" : { "account" : { "type" : "integer", "format" : "int64" }, "attachments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AttachmentParameter" } }, "bcc" : { "type" : "string" }, "category" : { "type" : "string" }, "cc" : { "type" : "string" }, "channel" : { "type" : "integer", "format" : "int32" }, "contact" : { "type" : "integer", "format" : "int64" }, "crmData" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } }, "customer" : { "type" : "string" }, "language" : { "type" : "string" }, "processId" : { "type" : "integer", "format" : "int64" }, "refId" : { "type" : "string" }, "subject" : { "type" : "string" }, "template" : { "type" : "string" }, "user" : { "type" : "string" } } }, "NoteParameters" : { "type" : "object", "properties" : { "text" : { "type" : "string" } } }, "NoteResponse" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date-time" }, "emailId" : { "type" : "integer", "format" : "int64" }, "text" : { "type" : "string" }, "userAddress" : { "type" : "string" } } }, "NotificationParameter" : { "type" : "object", "properties" : { "message" : { "type" : "string" }, "title" : { "type" : "string" }, "user" : { "type" : "string" } } }, "ParameterEntry" : { "type" : "object", "properties" : { "parameter" : { "type" : "string" }, "values" : { "type" : "array", "items" : { "type" : "string" } } } }, "PhoneSystemRequest" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : false, "description" : "Flag that indicates if the phone system plugin is enabled" }, "name" : { "type" : "string", "description" : "The unique name of the phone system plugin.", "example" : "my-phonesystem" }, "tenantIds" : { "type" : "array", "description" : "Array containing the id(s) of the assigned tenant(s) to this phone system plugin", "items" : { "type" : "integer", "format" : "int64", "description" : "Array containing the id(s) of the assigned tenant(s) to this phone system plugin" } }, "type" : { "type" : "string", "description" : "The type name of the phone system plugin.", "example" : "novomind Call Connector" } }, "required" : [ "name", "type" ] }, "PhoneSystemResponse" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "description" : "Flag that indicates if the phone system plugin is enabled" }, "id" : { "type" : "integer", "format" : "int64", "description" : "The entity id of the phone system plugin.", "example" : 100 }, "links" : { "type" : "array", "description" : "Array of Links to related actions or entities", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string", "description" : "The unique name of the phone system plugin.", "example" : "my-phonesystem" }, "status" : { "type" : "integer", "format" : "int32", "description" : "Number representation of the phone system plugin status ('1' = enabled and connected, '2' = enabled but has warnings or errors, '3' = disabled" }, "tenantIds" : { "type" : "array", "description" : "Array containing the id(s) of the assigned tenant(s) to this phone system plugin", "items" : { "type" : "integer", "format" : "int64", "description" : "Array containing the id(s) of the assigned tenant(s) to this phone system plugin" } }, "type" : { "type" : "string", "description" : "The type name of the phone system plugin.", "example" : "novomind Call Connector" } } }, "PreFilledReportResponse" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" } } }, "PrivilegeResponse" : { "type" : "object", "properties" : { "groupingName" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" } } }, "Property" : { "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "key of the property", "example" : "myKey" }, "type" : { "type" : "string", "default" : "STRING", "enum" : [ "BOOLEAN", "DATE", "DOUBLE", "ENCRYPTED_STRING", "LONG", "STRING" ], "example" : "DATE" }, "value" : { "type" : "string", "description" : "value of the property set to null to delete a property", "example" : "1970-01-01T13:37:17+0100", "nullable" : true } } }, "PropertyListResponse" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } } }, "required" : [ "data" ] }, "ReportRequest" : { "type" : "object", "properties" : { "from" : { "type" : "string", "format" : "date-time" }, "grouping" : { "type" : "array", "items" : { "type" : "string" } }, "parameters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ParameterEntry" } }, "to" : { "type" : "string", "format" : "date-time" }, "type" : { "type" : "string" } } }, "ReportResponse" : { "type" : "object", "properties" : { "acceptedParameters" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "description" : { "type" : "string" }, "groupByParameters" : { "type" : "array", "items" : { "type" : "string" } }, "groupingRequired" : { "type" : "boolean" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "mandatoryParameters" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "privilegeType" : { "type" : "integer", "format" : "int32" }, "reportId" : { "type" : "string" }, "title" : { "type" : "string" }, "uid" : { "type" : "string" } } }, "RoutingInfoResponse" : { "type" : "object", "properties" : { "autoprocessError" : { "type" : "boolean" }, "error" : { "type" : "boolean" }, "inboxSize" : { "type" : "integer", "format" : "int32" }, "inboxVolumeKB" : { "type" : "integer", "format" : "int32" }, "outboxSize" : { "type" : "integer", "format" : "int32" }, "running" : { "type" : "boolean" }, "slaveLoad" : { "$ref" : "#/components/schemas/SlaveLoadResponse" }, "starting" : { "type" : "boolean" }, "stopping" : { "type" : "boolean" }, "workflowEventQueueLoad" : { "type" : "integer", "format" : "int32" } } }, "RoutingTagResponse" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" } } }, "ServerInfoResponse" : { "type" : "object", "properties" : { "licenseExpiryDays" : { "type" : "integer", "format" : "int32" }, "mailsPerMonth" : { "type" : "integer", "format" : "int32" }, "maxMailsPerMonth" : { "type" : "integer", "format" : "int32" }, "version" : { "type" : "string" } } }, "SignalParameter" : { "type" : "object", "properties" : { "action" : { "type" : "string" }, "callId" : { "type" : "string" }, "timeout" : { "type" : "integer", "format" : "int64" }, "user" : { "type" : "string" } } }, "SlaveLoadResponse" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32" }, "max" : { "type" : "integer", "format" : "int32" }, "min" : { "type" : "integer", "format" : "int32" }, "sum" : { "type" : "integer", "format" : "int32" }, "table" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SlaveResponse" } } } }, "SlaveResponse" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" } } }, "StatusResponse" : { "type" : "object", "properties" : { "message" : { "type" : "string" }, "status" : { "type" : "integer", "format" : "int32" } } }, "SystemGroupRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "name" : { "type" : "string" }, "parentId" : { "type" : "integer", "format" : "int64" } } }, "SystemGroupResponse" : { "type" : "object", "properties" : { "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int64" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" } } }, "TenantInfo" : { "type" : "object", "properties" : { "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" } } }, "TenantRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "name" : { "type" : "string" } } }, "TenantResponse" : { "type" : "object", "properties" : { "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int64" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" } } }, "TextModuleFirstLevelGroupRequest" : { "type" : "object", "properties" : { "classification" : { "type" : "string", "enum" : [ "NO_CLASSIFICATION", "GREETING", "BODY", "ENDING" ] }, "id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "visible" : { "type" : "boolean" } } }, "TextModuleFirstLevelGroupResponse" : { "type" : "object", "properties" : { "classification" : { "type" : "string" }, "createdDate" : { "type" : "string", "format" : "date-time" }, "deleted" : { "type" : "boolean" }, "id" : { "type" : "integer", "format" : "int64" }, "lastChangedDate" : { "type" : "string", "format" : "date-time" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" }, "visible" : { "type" : "boolean" } } }, "TextModuleNodeRequest" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" } } }, "TextModuleNodeResponse" : { "type" : "object", "properties" : { "createdDate" : { "type" : "string", "format" : "date-time" }, "deleted" : { "type" : "boolean" }, "id" : { "type" : "integer", "format" : "int64" }, "lastChangedDate" : { "type" : "string", "format" : "date-time" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" } } }, "TextModuleRequest" : { "type" : "object", "properties" : { "content" : { "type" : "string" }, "description" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int64" }, "languageCode" : { "type" : "string" }, "name" : { "type" : "string" }, "notifyAgents" : { "type" : "boolean" }, "shortcut" : { "type" : "string" }, "topTextRelevant" : { "type" : "boolean" }, "visible" : { "type" : "boolean" } } }, "TextModuleResponse" : { "type" : "object", "properties" : { "content" : { "type" : "string" }, "createdDate" : { "type" : "string", "format" : "date-time" }, "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int64" }, "languageCode" : { "type" : "string" }, "lastChangeDateWithNotify" : { "type" : "string", "format" : "date-time" }, "lastChangedDate" : { "type" : "string", "format" : "date-time" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" }, "shortcut" : { "type" : "string" }, "topTextRelevant" : { "type" : "boolean" }, "visible" : { "type" : "boolean" } } }, "TextModuleRootResponse" : { "type" : "object", "properties" : { "deleted" : { "type" : "boolean" }, "id" : { "type" : "integer", "format" : "int64" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } } } }, "TextModuleSecondLevelGroupRequest" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "parentId" : { "type" : "integer", "format" : "int64" } } }, "TextModuleSecondLevelGroupResponse" : { "type" : "object", "properties" : { "createdDate" : { "type" : "string", "format" : "date-time" }, "deleted" : { "type" : "boolean" }, "id" : { "type" : "integer", "format" : "int64" }, "lastChangedDate" : { "type" : "string", "format" : "date-time" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "name" : { "type" : "string" } } }, "TransactionCodeRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "localizedDescriptions" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "localizedDisplayNames" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "name" : { "type" : "string" } } }, "TransactionCodeResponse" : { "type" : "object", "properties" : { "deleted" : { "type" : "boolean" }, "description" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int64" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "localizedDescriptions" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "localizedDisplayNames" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "name" : { "type" : "string" } } }, "UserAgentGroupAssignmentRequest" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "skill" : { "type" : "integer", "format" : "int32" } } }, "UserAgentGroupAssignmentResponse" : { "type" : "object", "properties" : { "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "skill" : { "type" : "integer", "format" : "int32" } } }, "UserRequest" : { "type" : "object", "properties" : { "address" : { "type" : "string" }, "agent" : { "type" : "boolean" }, "autoRoutingCategoryMode" : { "type" : "string" }, "clearanceRequired" : { "type" : "boolean" }, "language" : { "type" : "string" }, "locationId" : { "type" : "integer", "format" : "int64" }, "locked" : { "type" : "boolean" }, "manualRoutingCategoryMode" : { "type" : "string" }, "maxChats" : { "type" : "integer", "format" : "int32" }, "maxMails" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "password" : { "type" : "string" }, "signature" : { "type" : "string" }, "username" : { "type" : "string" } } }, "UserResponse" : { "type" : "object", "properties" : { "address" : { "type" : "string" }, "agent" : { "type" : "boolean" }, "agentLoginStatus" : { "type" : "boolean" }, "autoRoutingCategoryMode" : { "type" : "string", "enum" : [ "ALL_CATEGORIES", "TENANT_CATEGORIES", "ASSIGNED_CATEGORIES", "DISABLED" ] }, "clearanceRequired" : { "type" : "boolean" }, "deleted" : { "type" : "boolean" }, "deviceState" : { "type" : "integer", "format" : "int32" }, "hasMandatorFilter" : { "type" : "boolean" }, "id" : { "type" : "integer", "format" : "int64" }, "language" : { "type" : "string" }, "languageSkills" : { "type" : "array", "items" : { "type" : "string" }, "uniqueItems" : true }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkResponse" } }, "locationId" : { "type" : "integer", "format" : "int64" }, "locked" : { "type" : "boolean" }, "loginStatus" : { "type" : "boolean" }, "manualRoutingCategoryMode" : { "type" : "string", "enum" : [ "ALL_CATEGORIES", "TENANT_CATEGORIES", "ASSIGNED_CATEGORIES", "DISABLED" ] }, "maxChats" : { "type" : "integer", "format" : "int32" }, "maxMails" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "paused" : { "type" : "boolean" }, "routingTags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoutingTagResponse" }, "uniqueItems" : true }, "signature" : { "type" : "string" }, "supervisor" : { "type" : "boolean" }, "username" : { "type" : "string" } } } }, "securitySchemes" : { "oAuth2" : { "flows" : { "implicit" : { "authorizationUrl" : "../rest/auth" } }, "in" : "header", "type" : "oauth2" } } } }