{ "openapi" : "3.1.0", "info" : { "title" : "Task", "version" : "1.0.0" }, "paths" : { "/api/v1/tasks/updateMany" : { "post" : { "tags" : [ "Task" ], "summary" : "Update many tasks", "description" : "This API updates multiple tasks at once.", "operationId" : "bulkUpdateTasks", "x-mcp-group" : [ "Tasks" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/task_massupdate" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./CommonMassActionResponse.json#/components/responses/massActionListView" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.activities.tasks.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.tasks.UPDATE" ] } ] } }, "/api/v1/tasks/deleteSpam" : { "post" : { "tags" : [ "Task" ], "summary" : "Delete spam tasks", "description" : "This API deletes the given spam tasks", "operationId" : "deleteSpamTasks", "x-mcp-group" : [ "Tasks" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/spamDeleteJSON" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.activities.tasks.DELETE" ] } ] } }, "/api/v1/tasks/{taskId}" : { "get" : { "tags" : [ "Task" ], "summary" : "Get task", "description" : "This API fetches a task from your help desk portal.", "operationId" : "getTask", "x-mcp-group" : [ "Tasks" ], "parameters" : [ { "name" : "include", "in" : "query", "description" : "Additional information related to the task. Values allowed are: contacts, assignee, tickets, teams, projects, creator.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string" ], "enum" : [ "contacts", "tickets", "assignee", "teams", "projects", "creator" ] }, "uniqueItems" : true } }, { "name" : "taskId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "description" : "Unique ID of the task" }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "#/components/responses/taskResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.activities.tasks.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.tasks.READ" ] } ] }, "patch" : { "tags" : [ "Task" ], "operationId" : "updateTask", "x-mcp-group" : [ "Tasks" ], "summary" : "Update a task", "description" : "This API helps update the details of a task.", "parameters" : [ { "name" : "taskId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "description" : "Unique ID of the task" }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/taskjson" }, "responses" : { "200" : { "$ref" : "#/components/responses/taskResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.activities.tasks.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.tasks.UPDATE" ] } ] } }, "/api/v1/tasks/emptySpam" : { "post" : { "tags" : [ "Task" ], "summary" : "Empty spam tasks", "description" : "This API deletes all spam tasks.", "operationId" : "deleteAllSpamTasks", "x-mcp-group" : [ "Tasks" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/emptyTasksSpamResponse" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "202" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.activities.tasks.DELETE" ] } ] } }, "/api/v1/tasks/moveToTrash" : { "post" : { "tags" : [ "Task" ], "summary" : "Delete tasks", "description" : "This API moves task entries to the Recycle Bin of your help desk portal.", "operationId" : "deleteTask", "x-mcp-group" : [ "Tasks" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/trashJson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.activities.tasks.DELETE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.tasks.DELETE" ] } ] } }, "/api/v1/tasks" : { "get" : { "tags" : [ "Task" ], "summary" : "List tasks", "description" : "This API fetches a particular number of tasks, based on the limit specified.", "operationId" : "getTasks", "x-mcp-group" : [ "Tasks" ], "parameters" : [ { "name" : "include", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string" ], "enum" : [ "contacts", "tickets", "assignee", "teams", "projects" ] }, "uniqueItems" : true }, "description" : "Additional information to include in the response" }, { "name" : "departmentIds", "in" : "query", "required" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "maxItems" : 20 }, "style" : "form", "explode" : true, "description" : "Departments from which the tasks need to be queried" }, { "name" : "viewId", "in" : "query", "required" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "style" : "form", "explode" : true, "description" : "ID of the view to apply while fetching the resources" }, { "name" : "assignee", "in" : "query", "required" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "maxItems" : 20 }, "style" : "form", "explode" : true, "description" : "Key that filters tickets by assignee. Values allowed are any valid assignee ID or multiple assignee IDs separated by commas." }, { "name" : "dueDate", "in" : "query", "required" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string" ], "enum" : [ "Overdue", "Today", "Tomorrow", "CurrentWeek", "CurrentMonth" ] }, "maxItems" : 10 }, "style" : "form", "explode" : true, "description" : "Due date for completing the task. Values allowed are Overdue, Tomorrow, CurrentWeek, CurrentMonth and Today. You can pass multiple values by separating them with commas." }, { "name" : "isCompleted", "in" : "query", "required" : false, "schema" : { "type" : [ "boolean" ] }, "style" : "form", "explode" : true, "description" : "Key that denotes whether the task is completed or not" }, { "name" : "departmentId", "in" : "query", "description" : "ID of the department from which the task count must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "name" : "limit", "in" : "query", "description" : "Number of tasks to list", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "maximum" : 100, "minimum" : 1, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the tasks must be listed", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "pattern" : "([0-9]+)" } }, { "name" : "sortBy", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "enum" : [ "category", "subject", "dueDate", "status", "createdTime", "modifiedTime", "priority" ], "pattern" : "-?(category|subject|dueDate|status||createdTime|modifiedTime|priority)" }, "description" : "Sorts tasks by the specified attribute" }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "fields", "in" : "query", "required" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string" ] } }, "description" : "Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: photoURL, webUrl. Maximum of 30 fields is supported as comma separated values.", "style" : "form", "explode" : false }, { "name" : "filters", "in" : "query", "required" : false, "schema" : { "$ref" : "./Ticket.json#/components/schemas/filter_json" }, "description" : "To fetch the tasks based on the filters specified in the criteria JSON, which includes the field and its conditions." }, { "name" : "filterId", "in" : "query", "required" : false, "schema" : { "type" : [ "integer", "string" ], "pattern" : "([0-9]+)", "format" : "int64" }, "description" : "ID of the SavedFilter to filter the records" } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "200" : { "$ref" : "#/components/responses/getTasksListResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.activities.tasks.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.tasks.READ" ] } ] }, "post" : { "tags" : [ "Task" ], "summary" : "Create task", "description" : "This API creates a task in your help desk portal.", "operationId" : "createTask", "x-mcp-group" : [ "Tasks" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/addTask_taskjson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "#/components/responses/taskResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.activities.tasks.CREATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.tasks.CREATE" ] } ] } }, "/api/v1/tickets/{ticketId}/tasks" : { "get" : { "tags" : [ "Task" ], "summary" : "List tasks by ticket", "description" : "This API lists all tasks associated with a particular ticket.", "operationId" : "getTasksByTicket", "x-mcp-group" : [ "Tasks" ], "parameters" : [ { "name" : "include", "in" : "query", "description" : "Additional information related to the task. Values allowed are: contacts, assignee, tickets, teams, projects.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string" ], "enum" : [ "contacts", "tickets", "assignee", "teams", "projects" ] }, "uniqueItems" : true } }, { "name" : "limit", "in" : "query", "description" : "Number of tasks to list", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "maximum" : 100, "minimum" : 1, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the tasks must be listed", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "pattern" : "([0-9]+)" } }, { "name" : "sortBy", "in" : "query", "description" : "Key that sorts the tasks by a specific attribute: dueDate or createdTime. The default sorting order is ascending. A - prefix denotes a descending order of sorting.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "enum" : [ "category", "subject", "dueDate", "status", "createdTime", "modifiedTime", "priority" ], "pattern" : "-?(category|subject|dueDate|status|createdTime|modifiedTime|priority)" } }, { "name" : "isSpam", "in" : "query", "description" : "Key that denotes whether to fetch spam tasks or not", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "boolean" ] } }, { "name" : "isCompleted", "in" : "query", "description" : "Key that denotes if the task was completed or not", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "boolean" ] } }, { "name" : "ticketId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "description" : "Unique ID of the ticket" }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "200" : { "$ref" : "#/components/responses/taskListViewArray" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.activities.tasks.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.tasks.READ", "Desk.tickets.READ" ] } ] } }, "/api/v1/tasks/count" : { "get" : { "tags" : [ "Task" ], "summary" : "List all tasks count", "description" : "This API returns the number of tasks in your help desk.", "operationId" : "getTasksCount", "x-mcp-group" : [ "Tasks" ], "parameters" : [ { "name" : "viewId", "in" : "query", "description" : "ID of the view to apply while fetching the resources", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "name" : "departmentId", "in" : "query", "description" : "ID of the department from which the task count must be fetched", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "allDepartment|[0-9]+" } }, { "name" : "dueDate", "in" : "query", "description" : "Filter by task duedate. Values allowed are Overdue, Tomorrow, CurrentWeek, CurrentMonth and Today. You can include both values by separating them with a comma", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string" ], "enum" : [ "Overdue", "Today", "Tomorrow", "CurrentWeek", "CurrentMonth" ] }, "uniqueItems" : true } }, { "name" : "assignee", "in" : "query", "description" : " Key that filters tasks by assignee. A valid assigneeId must be passed for this parameter. Multiple assigneeIds can be passed as comma-separated values.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "filterId", "in" : "query", "required" : false, "schema" : { "type" : [ "integer", "string" ], "pattern" : "([0-9]+)", "format" : "int64" }, "description" : "Id of the SavedFilter to filter the records" } ], "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "200" : { "$ref" : "#/components/responses/countResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.activities.tasks.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.tasks.READ" ] } ] } } }, "components" : { "schemas" : { "long_array" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "assignee" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the profile photo" }, "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "First name of the user" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Last name of the user" }, "emailId" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$", "description" : "Email address of the user" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the user" } }, "required" : [ "emailId", "firstName", "id", "lastName", "photoURL" ] }, "relativeReminder" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "relativeReminderInMin" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Time offset in minutes before the task starts" }, "alertType" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "enum" : [ "EMAIL", "POPUP", "SMS" ] }, "uniqueItems" : true, "description" : "Type of alert(s) related to the reminder. Accepted values: EMAIL, POPUP, SMS" }, "reminderType" : { "type" : [ "string", "null" ], "enum" : [ "RELATIVE" ], "description" : "Type of the reminder. Value: RELATIVE" } }, "required" : [ "alertType", "relativeReminderInMin", "reminderType" ] }, "absoluteReminder" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "alertType" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "enum" : [ "EMAIL", "POPUP", "SMS" ] }, "uniqueItems" : true, "description" : "Type of alert(s) related to the reminder. Accepted values: EMAIL, POPUP, SMS" }, "reminderType" : { "type" : [ "string", "null" ], "enum" : [ "ABSOLUTE" ], "description" : "Type of the reminder. Value: ABSOLUTE" }, "reminderTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the reminder is triggered" } }, "required" : [ "alertType", "reminderTime", "reminderType" ] }, "reminderArray" : { "type" : [ "array", "null" ], "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/relativeReminder" }, { "$ref" : "#/components/schemas/absoluteReminder" } ] } }, "taskListByContactOrAccountJson" : { "type" : [ "object" ], "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonJsonResponse" }, { "type" : [ "object", "null" ], "properties" : { "callId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the call associated with the task" }, "modifiedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the task was last modified" }, "statusType" : { "type" : [ "string", "null" ], "enum" : [ "Open", "Closed" ], "description" : "Type of the task status. Accepted values: Open, Closed" }, "completedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the task was completed" }, "creatorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the user who created the task" }, "activityTime" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Activity time of the task" }, "layoutId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the layout associated with the task" }, "isTrashed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the task is in the Recycle Bin" }, "isCommented" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the task contains comments" }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)", "description" : "URL to access the task" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the task was created" }, "modifiedBy" : { "$ref" : "#/components/schemas/assignee" }, "startTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Start time of the task" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the task" }, "isSpam" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the task is marked as spam" }, "category" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true, "description" : "Category of the task" }, "direction" : { "type" : [ "string", "null" ], "enum" : [ "inbound", "outbound" ], "description" : "Direction of the activity" } }, "required" : [ "activityTime", "callId", "category", "completedTime", "createdTime", "creatorId", "direction", "id", "isCommented", "isSpam", "isTrashed", "layoutId", "modifiedBy", "modifiedTime", "startTime", "statusType", "webUrl" ], "additionalProperties" : false } ], "required" : [ "departmentId", "subject" ] }, "taskListViewJson" : { "type" : [ "object" ], "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonJsonResponse" }, { "type" : [ "object", "null" ], "properties" : { "modifiedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the task was last modified" }, "statusType" : { "type" : [ "string", "null" ], "enum" : [ "Open", "Closed" ], "description" : "Type of the task status. Accepted values: Open, Closed" }, "completedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the task was completed" }, "creatorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the user who created the task" }, "activityTime" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Activity time of the task" }, "layoutId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the layout associated with the task" }, "isTrashed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the task is in the Recycle Bin" }, "isCommented" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the task contains comments" }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)", "description" : "URL to access the task" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the task was created" }, "modifiedBy" : { "$ref" : "#/components/schemas/assignee" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the task" }, "isSpam" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the task is marked as spam" }, "category" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true, "description" : "Category of the task" } }, "required" : [ "activityTime", "category", "completedTime", "createdTime", "creatorId", "id", "isCommented", "isSpam", "isTrashed", "layoutId", "modifiedBy", "modifiedTime", "statusType", "webUrl" ], "additionalProperties" : false } ], "required" : [ "contactId", "departmentId", "dueDate", "ownerId", "priority", "status", "subject", "ticketId" ] }, "data" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/taskListViewJson" } }, "taskTableViewJson" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "subject" : { "type" : [ "string", "null" ], "maxLength" : 300, "minLength" : 0, "description" : "Subject of the task" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the task" } }, "required" : [ "id", "subject" ] }, "tableViewData" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/taskTableViewJson" } }, "taskTableViewIncludeJson" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "contactId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the contact associated with the task" }, "subject" : { "type" : [ "string", "null" ], "maxLength" : 300, "minLength" : 0, "description" : "Subject of the task" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the task" }, "ticketId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the ticket associated with the task" } }, "required" : [ "contactId", "id", "subject", "ticketId" ] }, "tableViewIncludeData" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/taskTableViewIncludeJson" } }, "taskTableViewTicketIdJson" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "subject" : { "type" : [ "string", "null" ], "maxLength" : 300, "minLength" : 0, "description" : "Subject of the task" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the task" }, "ticketId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the ticket associated with the task" } }, "required" : [ "id", "subject", "ticketId" ] }, "tableViewTicketIdData" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/taskTableViewTicketIdJson" } }, "taskTableViewContactIdJson" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "contactId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the contact associated with the task" }, "subject" : { "type" : [ "string", "null" ], "maxLength" : 300, "minLength" : 0, "description" : "Subject of the task" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the task" } }, "required" : [ "contactId", "id", "subject" ] }, "tableViewContactIdData" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/taskTableViewContactIdJson" } }, "contactJson" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 40, "minLength" : 0, "description" : "First name of the contact" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "description" : "Last name of the contact" }, "accountId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the account associated with the contact" }, "phone" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+", "description" : "Phone number of the contact" }, "mobile" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+", "description" : "Mobile number of the contact" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the contact" }, "isSpam" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the contact is marked as spam" }, "email" : { "type" : [ "string", "null" ], "maxLength" : 255, "minLength" : 0, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$", "description" : "Email address of the contact" } }, "required" : [ "accountId", "email", "firstName", "id", "isSpam", "lastName", "mobile", "phone" ] }, "commonJsonResponse" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "contactId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "description" : "ID of the contact associated with the task", "pattern" : "([0-9]+)" }, "subject" : { "type" : [ "string", "null" ], "description" : "Subject of the task", "maxLength" : 300, "minLength" : 0 }, "departmentId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "description" : "ID of the department in which the task must be created", "pattern" : "([0-9]+)" }, "dueDate" : { "type" : [ "string", "null" ], "description" : "Due date for completing the task", "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "ownerId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "description" : "ID of the user to whom the task is assigned", "pattern" : "([0-9]+)" }, "priority" : { "type" : [ "string", "null" ], "description" : "Priority of the task", "x-dynamic-enum" : true }, "ticketId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "description" : "ID of the ticket with which the task must be associated", "pattern" : "([0-9]+)" }, "status" : { "type" : [ "string", "null" ], "description" : "Status of task completion", "x-dynamic-enum" : true } } }, "commonJsonRequest" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "contactId" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "ID of the contact associated with the task", "pattern" : "([0-9]*|null|undefined)" }, "subject" : { "type" : [ "string" ], "description" : "Subject of the task", "maxLength" : 300 }, "departmentId" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "ID of the department in which the task must be created", "pattern" : "([0-9]+)" }, "dueDate" : { "type" : [ "string" ], "description" : "Due date for completing the task", "maxLength" : 100, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null" }, "ownerId" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "ID of the user to whom the task is assigned", "pattern" : "([0-9]*|null|undefined)" }, "priority" : { "type" : [ "string" ], "description" : "Priority of the task", "x-dynamic-enum" : true, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+" }, "ticketId" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "ID of the ticket with which the task must be associated", "pattern" : "([0-9]+)" }, "status" : { "type" : [ "string" ], "description" : "Status of task completion", "x-dynamic-enum" : true, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+" } } } }, "responses" : { "taskResponse" : { "description" : "taskResponse template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonJsonResponse" }, { "type" : [ "object", "null" ], "properties" : { "ticket" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "ticketNumber" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Index or serial number of the ticket" }, "subject" : { "type" : [ "string", "null" ], "maxLength" : 1000, "minLength" : 0, "description" : "Subject of the ticket" }, "isArchived" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the ticket is archived" }, "dueDate" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Due date of the ticket" }, "channel" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true, "description" : "Channel of the ticket" }, "closedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the ticket was closed" }, "phone" : { "type" : [ "string", "null" ], "maxLength" : 120, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+", "description" : "Phone number associated with the ticket" }, "teamId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the team associated with the ticket" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the ticket was created" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the ticket" }, "assignee" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "First name of the ticket assignee" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Last name of the ticket assignee" }, "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the profile photo of the ticket assignee" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the ticket assignee" } }, "required" : [ "firstName", "id", "lastName", "photoURL" ], "description" : "Details of the agent assigned to the ticket" }, "isSpam" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the ticket is marked as spam" }, "status" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true, "description" : "Status of the ticket" }, "niceUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)", "description" : "URL to open the associated ticket in the Desk agent UI. Returned only when the featureFlags request header includes reactChanges." } }, "required" : [ "assignee", "channel", "closedTime", "createdTime", "dueDate", "id", "isArchived", "isSpam", "phone", "status", "subject", "teamId", "ticketNumber" ], "description" : "Details of the ticket associated with the task" }, "contact" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 40, "minLength" : 0, "description" : "First name of the contact" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "description" : "Last name of the contact" }, "accountId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the account associated with the contact" }, "phone" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+", "description" : "Phone number of the contact" }, "mobile" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+", "description" : "Mobile number of the contact" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the contact" }, "isSpam" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the contact is marked as spam" }, "email" : { "type" : [ "string", "null" ], "maxLength" : 255, "minLength" : 0, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$", "description" : "Email address of the contact" }, "niceUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)", "description" : "URL to open the associated contact in the Desk agent UI. Returned only when the featureFlags request header includes reactChanges." } }, "required" : [ "accountId", "email", "firstName", "id", "isSpam", "lastName", "mobile", "phone" ], "description" : "Details of the contact associated with the task" }, "modifiedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the task was last modified" }, "cf" : { "type" : [ "object", "null" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } }, "description" : "User-defined fields related to the task" }, "reminder" : { "$ref" : "#/components/schemas/reminderArray" }, "statusType" : { "type" : [ "string", "null" ], "enum" : [ "Open", "Closed" ], "description" : "Type of the task status. Accepted values: Open, Closed" }, "contactId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the contact associated with the task" }, "customFields" : { "type" : [ "object", "null" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } }, "description" : "User-defined fields related to the task. Deprecated: use cf instead" }, "completedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the task was completed" }, "creatorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the user who created the task" }, "description" : { "type" : [ "string", "null" ], "maxLength" : 65535, "minLength" : 0, "description" : "Description of the task" }, "activityTime" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Activity time of the task" }, "layoutId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the layout associated with the task" }, "isTrashed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the task is in the Recycle Bin" }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)", "description" : "URL to access the task" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the task was created" }, "modifiedBy" : { "$ref" : "#/components/schemas/assignee" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the task" }, "isSpam" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the task is marked as spam" }, "category" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true, "description" : "Category of the task" } }, "required" : [ "activityTime", "category", "cf", "completedTime", "contactId", "createdTime", "creatorId", "customFields", "description", "id", "isSpam", "isTrashed", "layoutId", "modifiedBy", "modifiedTime", "reminder", "statusType", "webUrl" ], "additionalProperties" : false } ], "required" : [ "contactId", "departmentId", "dueDate", "ownerId", "priority", "status", "subject", "ticketId" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "modifiedTime" : 1468487681000, "cf" : { }, "subject" : "Bug Fix #120", "departmentId" : "3000000007043", "dueDate" : 1469117776000, "creatorId" : "3000000008692", "description" : null, "ownerId" : null, "priority" : "High", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Tasks/dv/51123033fe97b2f886f750280ded9c40", "createdTime" : 1468484846000, "modifiedBy" : { "firstName" : "George", "lastName" : "McKinson", "photoURL" : null, "id" : "5000000015911" }, "id" : "3000000054002", "isSpam" : false, "category" : "null", "ticketId" : "3000000008753", "status" : "In Progress" } } } } } }, "getTasksListResponse" : { "description" : "getTasksListResponse template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "allOf" : [ { "type" : [ "object" ], "properties" : { "data" : { "type" : [ "array" ], "items" : { "type" : [ "object" ], "properties" : { "ticket" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "contact" : { "$ref" : "#/components/schemas/contactJson" }, "team" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "name" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 1, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "Name of the team" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the team" }, "logoUrl" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)", "description" : "URL of the team logo" } }, "required" : [ "id", "logoUrl", "name" ], "description" : "Details of the team associated with the ticket" }, "ticketNumber" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Index or serial number of the ticket" }, "subject" : { "type" : [ "string", "null" ], "maxLength" : 1000, "minLength" : 0, "description" : "Subject of the ticket" }, "isArchived" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the ticket is archived" }, "dueDate" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Due date of the ticket" }, "channel" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true, "description" : "Channel of the ticket" }, "closedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the ticket was closed" }, "phone" : { "type" : [ "string", "null" ], "maxLength" : 120, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+", "description" : "Phone number associated with the ticket" }, "teamId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the team associated with the ticket" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the ticket was created" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the ticket" }, "assignee" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "First name of the ticket assignee" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Last name of the ticket assignee" }, "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the profile photo of the ticket assignee" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the ticket assignee" } }, "required" : [ "firstName", "id", "lastName", "photoURL" ], "description" : "Details of the agent assigned to the ticket" }, "isSpam" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the ticket is marked as spam" }, "status" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true, "description" : "Status of the ticket" } }, "required" : [ "assignee", "channel", "closedTime", "createdTime", "dueDate", "id", "isArchived", "isSpam", "phone", "status", "subject", "teamId", "ticketNumber" ], "description" : "Details of the ticket associated with the task" }, "contact" : { "$ref" : "#/components/schemas/contactJson" }, "assignee" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "First name of the task assignee" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Last name of the task assignee" }, "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the profile photo of the task assignee" }, "emailId" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$", "description" : "Email address of the task assignee" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the task assignee" } }, "required" : [ "emailId", "firstName", "id", "lastName", "photoURL" ], "description" : "Details of the agent assigned to the task" }, "team" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "name" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 1, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "Name of the team" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the team" }, "logoUrl" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)", "description" : "URL of the team logo" } }, "required" : [ "id", "logoUrl", "name" ], "description" : "Details of the team associated with the task" } }, "additionalProperties" : false }, "description" : "List of task entries" } }, "additionalProperties" : false }, { "type" : [ "object" ], "properties" : { "data" : { "$ref" : "#/components/schemas/data" } }, "additionalProperties" : false } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "ticket" : null, "contactId" : null, "subject" : "Iphone charger replacement", "completedTime" : null, "departmentId" : "5000000012710", "dueDate" : null, "creatorId" : "5000000015911", "team" : null, "ownerId" : "5000000067003", "priority" : "Normal", "isCommented" : false, "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Tasks/dv/d4c0a5dce55dcf20279262cd8594cd0d", "contact" : null, "createdTime" : 1556634110000, "startTime" : 0, "id" : "5000000209940", "assignee" : { "firstName" : "George", "lastName" : "36", "photoURL" : null, "id" : "5000000067003" }, "isSpam" : false, "category" : null, "activityType" : "Tasks", "ticketId" : null, "status" : "Not Started", "direction" : "inbound" }, { "ticket" : { "ticketNumber" : "101", "phone" : "+1 5550100123", "subject" : "Here's your first ticket.", "dueDate" : 1553853086000, "teamId" : null, "id" : "5000000016294", "assignee" : { "photoURL" : null, "firstName" : "George", "lastName" : "McKinson", "id" : "5000000015911" }, "isSpam" : false, "status" : "Open" }, "contactId" : null, "subject" : "Tempered glass replacement", "completedTime" : null, "departmentId" : "5000000012710", "dueDate" : 1556211131000, "creatorId" : "5000000015911", "team" : { "name" : "Desk Team", "id" : "3691000006805021", "logoUrl" : "https://desk.zoho.com/api/v1/teams/3691000006805021/logo?orgId=123456" }, "ownerId" : "5000000015911", "priority" : "High", "isCommented" : false, "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Tasks/dv/9d4883f2d94d59e46474bbeb6432292e", "teamId" : "3691000006805021", "contact" : null, "createdTime" : 1554784646000, "startTime" : 1556211131000, "id" : "5000000075033", "assignee" : { "firstName" : "George", "lastName" : "McKinson", "photoURL" : null, "id" : "5000000015911" }, "isSpam" : false, "category" : null, "activityType" : "Tasks", "ticketId" : "5000000016294", "status" : "Deferred12546", "direction" : "inbound" } ] } } } } } }, "taskListViewArray" : { "description" : "taskListViewArray template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "allOf" : [ { "type" : [ "object" ], "properties" : { "data" : { "type" : [ "array" ], "items" : { "type" : [ "object" ], "properties" : { "ticket" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "ticketNumber" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Index or serial number of the ticket" }, "subject" : { "type" : [ "string", "null" ], "maxLength" : 1000, "minLength" : 0, "description" : "Subject of the ticket" }, "isArchived" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the ticket is archived" }, "dueDate" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Due date of the ticket" }, "channel" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true, "description" : "Channel of the ticket" }, "closedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the ticket was closed" }, "phone" : { "type" : [ "string", "null" ], "maxLength" : 120, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+", "description" : "Phone number associated with the ticket" }, "teamId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the team associated with the ticket" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Time when the ticket was created" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the ticket" }, "assignee" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "First name of the ticket assignee" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Last name of the ticket assignee" }, "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the profile photo of the ticket assignee" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the ticket assignee" } }, "required" : [ "firstName", "id", "lastName", "photoURL" ], "description" : "Details of the agent assigned to the ticket" }, "isSpam" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the ticket is marked as spam" }, "status" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true, "description" : "Status of the ticket" }, "niceUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)", "description" : "URL to open the associated ticket in the Desk agent UI. Returned only when the featureFlags request header includes reactChanges." } }, "required" : [ "assignee", "channel", "closedTime", "createdTime", "dueDate", "id", "isArchived", "isSpam", "phone", "status", "subject", "teamId", "ticketNumber" ], "description" : "Details of the ticket associated with the task" }, "contact" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 40, "minLength" : 0, "description" : "First name of the contact" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "description" : "Last name of the contact" }, "accountId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the account associated with the contact" }, "phone" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+", "description" : "Phone number of the contact" }, "mobile" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+", "description" : "Mobile number of the contact" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the contact" }, "isSpam" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the contact is marked as spam" }, "email" : { "type" : [ "string", "null" ], "maxLength" : 255, "minLength" : 0, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$", "description" : "Email address of the contact" }, "niceUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)", "description" : "URL to open the associated contact in the Desk agent UI. Returned only when the featureFlags request header includes reactChanges." } }, "required" : [ "accountId", "email", "firstName", "id", "isSpam", "lastName", "mobile", "phone" ], "description" : "Details of the contact associated with the task" }, "assignee" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "First name of the task assignee" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Last name of the task assignee" }, "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the profile photo of the task assignee" }, "emailId" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$", "description" : "Email address of the task assignee" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the task assignee" } }, "required" : [ "emailId", "firstName", "id", "lastName", "photoURL" ], "description" : "Details of the agent assigned to the task" }, "team" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "name" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 1, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "Name of the team" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the team" }, "logoUrl" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)", "description" : "URL of the team logo" } }, "required" : [ "id", "logoUrl", "name" ], "description" : "Details of the team associated with the task" } }, "additionalProperties" : false }, "description" : "List of task entries" } }, "additionalProperties" : false }, { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "#/components/schemas/data" } }, "required" : [ "data" ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "subject" : "New gadget replacement with latest OS", "completedTime" : null, "departmentId" : "5000000012710", "dueDate" : 1556211131000, "creatorId" : "5000000015911", "ownerId" : "5000000015911", "secId" : "9d4883f2d94d59e4d4dad33a9adf3649", "isCommented" : false, "contact" : { "firstName" : null, "lastName" : "Lawrence", "phone" : "+1 5550100123", "mobile" : null, "id" : "5000000016252", "isSpam" : false, "secId" : "9d4883f2d94d59e42b7cc45393ad8ff8" }, "createdTime" : 1554708386000, "startTime" : 1556211131000, "id" : "5000000074002", "direction" : "inbound", "ticket" : { "ticketNumber" : "101", "phone" : "+1 5550100123", "subject" : "Here's your first ticket.", "dueDate" : 1553853086000, "teamId" : null, "id" : "5000000016294", "assignee" : { "photoURL" : null, "firstName" : "George", "lastName" : "McKinson", "id" : "5000000015911" }, "isSpam" : false, "status" : "Open", "secId" : "9d4883f2d94d59e415b08d3d4c697d42" }, "contactId" : "5000000016252", "team" : { "name" : "Desk Team", "id" : "3691000006805021", "logoUrl" : "https://desk.zoho.com/api/v1/teams/3691000006805021/logo?orgId=123456" }, "priority" : "High", "layoutId" : "5000000013466", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Tasks/dv/9d4883f2d94d59e4d4dad33a9adf3649", "teamId" : "3691000006805021", "assignee" : { "firstName" : "George", "lastName" : "McKinson", "photoURL" : null, "id" : "5000000015911" }, "isSpam" : false, "category" : null, "activityType" : "Tasks", "ticketId" : "5000000016294", "status" : "Deferred" }, { "subject" : "Tempered glass replacement", "completedTime" : null, "departmentId" : "5000000012710", "dueDate" : 1556211131000, "creatorId" : "5000000015911", "ownerId" : "5000000015911", "secId" : "9d4883f2d94d59e46474bbeb6432292e", "isCommented" : false, "contact" : null, "createdTime" : 1554784646000, "startTime" : 1556211131000, "id" : "5000000075033", "direction" : "inbound", "ticket" : { "ticketNumber" : "101", "phone" : "+1 5550100123", "subject" : "Here's your first ticket.", "dueDate" : 1553853086000, "teamId" : null, "id" : "5000000016294", "assignee" : { "photoURL" : null, "firstName" : "George", "lastName" : "McKinson", "id" : "5000000015911" }, "isSpam" : false, "status" : "Open", "secId" : "9d4883f2d94d59e415b08d3d4c697d42" }, "contactId" : null, "team" : null, "priority" : "High", "layoutId" : "5000000013466", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Tasks/dv/9d4883f2d94d59e46474bbeb6432292e", "teamId" : null, "assignee" : { "firstName" : "George", "lastName" : "McKinson", "photoURL" : null, "id" : "5000000015911" }, "isSpam" : false, "category" : null, "activityType" : "Tasks", "ticketId" : "5000000016294", "status" : "Deferred12546" } ] } } } } } }, "countResponse" : { "description" : "countResponse template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "count" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Number of tasks matching the specified criteria" } }, "required" : [ "count" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "count" : "10" } } } } } } }, "requestBodies" : { "task_massupdate" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "isCustomField" : { "type" : [ "boolean" ], "description" : "Indicates whether the specified field is a custom field" }, "fieldName" : { "type" : [ "string" ], "x-dynamic-enum" : true, "description" : "Name of the field to update" }, "ids" : { "$ref" : "#/components/schemas/long_array" }, "fieldValue" : { "type" : [ "string" ], "maxLength" : 320, "description" : "Value to set in the field" } }, "required" : [ "fieldName", "ids", "fieldValue" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "fieldName" : "mobile", "isCustomField" : false, "ids" : [ "1892000000093303", "1892000000085009", "1892000000050003" ], "fieldValue" : "8508569875" } } } } } }, "spamDeleteJSON" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "taskIds" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false, "description" : "ID(s) of the spam task(s) to delete" } }, "required" : [ "taskIds" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "taskIds" : [ "1892000000012307", "1892000000012308" ] } } } } } }, "taskjson" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonJsonRequest" }, { "type" : [ "object" ], "properties" : { "relativeReminderInMin" : { "type" : [ "string", "integer" ], "format" : "int32", "description" : "Time interval before which the reminder must be triggered. The value must denote the number of minutes.", "pattern" : "([0-9]+)" }, "alertType" : { "type" : [ "array" ], "items" : { "type" : [ "string" ], "enum" : [ "EMAIL", "POPUP", "SMS" ] }, "uniqueItems" : true, "description" : "Type of alert to use for the reminder. Accepted values: EMAIL, POPUP, SMS" }, "cf" : { "type" : [ "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } }, "description" : "User-defined fields related to the task" }, "customFields" : { "type" : [ "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } }, "description" : "User-defined fields related to the task. Deprecated: use cf instead" }, "reminderType" : { "type" : [ "string" ], "description" : "Type of reminder to associate with the task. Accepted values: Absolute, Relative.", "enum" : [ "ABSOLUTE", "RELATIVE" ] }, "absoluteReminderTime" : { "type" : [ "string" ], "description" : "Time when the reminder must be triggered", "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" } }, "additionalProperties" : false }, { "type" : [ "object" ], "properties" : { "category" : { "type" : [ "string" ], "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+", "x-regex-name" : "picklistValue", "maxLength" : 120, "description" : "Category of the task" }, "description" : { "type" : [ "string" ], "maxLength" : 65535, "description" : "Description of the task" }, "teamId" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]*|null|undefined)", "x-regex-name" : "long_null", "description" : "Unique ID of the team to which the task is assigned" }, "reminder" : { "type" : [ "array" ], "items" : { "type" : [ "object" ], "properties" : { "reminderTime" : { "type" : [ "string" ], "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null", "x-regex-name" : "APIDateTime", "description" : "Time when the reminder must be triggered" }, "reminderType" : { "type" : [ "string" ], "enum" : [ "ABSOLUTE", "RELATIVE" ], "x-regex-name" : "reminderType", "description" : "Type of the reminder. Accepted values: ABSOLUTE, RELATIVE" }, "relativeReminderInMin" : { "type" : [ "integer" ], "format" : "int32", "description" : "Time offset in minutes before the task starts" }, "alertType" : { "type" : [ "array" ], "items" : { "type" : [ "string" ], "enum" : [ "EMAIL", "POPUP", "SMS" ] }, "x-template" : "alert_template", "description" : "Type of alert(s) related to the reminder. Accepted values: EMAIL, POPUP, SMS" } } }, "maxLength" : 10000, "description" : "Details of the reminder set for the task" }, "layoutId" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the layout associated with the task" } } } ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "subject" : "Bug Fix #120", "departmentId" : "3000000007043", "dueDate" : "2016-07-21T16:16:16.000Z", "priority" : "High", "status" : "In Progress" } } } } } }, "emptyTasksSpamResponse" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "departmentId" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "ID of the department to which the activities belong", "pattern" : "([0-9]+)" } }, "required" : [ "departmentId" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "departmentId" : "4000000025121" } } } } } }, "trashJson" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "entityIds" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false, "description" : "ID(s) of the task(s) to move to the Recycle Bin" } }, "required" : [ "entityIds" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "entityIds" : [ "2000032003232" ] } } } } } }, "addTask_taskjson" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonJsonRequest" }, { "type" : [ "object" ], "properties" : { "relativeReminderInMin" : { "type" : [ "string", "integer" ], "format" : "int32", "description" : "Time interval before which the reminder must be triggered. The value must denote the number of minutes.", "pattern" : "([0-9]+)" }, "alertType" : { "type" : [ "array" ], "items" : { "type" : [ "string" ], "enum" : [ "EMAIL", "POPUP", "SMS" ] }, "uniqueItems" : true, "description" : "Type of alert to use for the reminder. Accepted values: EMAIL, POPUP, SMS" }, "cf" : { "type" : [ "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } }, "description" : "User-defined fields related to the task" }, "customFields" : { "type" : [ "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } }, "description" : "User-defined fields related to the task. Deprecated: use cf instead" }, "reminderType" : { "type" : [ "string" ], "description" : "Type of reminder to associate with the task. Accepted values: Absolute, Relative.", "enum" : [ "ABSOLUTE", "RELATIVE" ] }, "absoluteReminderTime" : { "type" : [ "string" ], "description" : "Time when the reminder must be triggered", "maxLength" : 100, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null" } }, "additionalProperties" : false }, { "type" : [ "object" ], "properties" : { "category" : { "type" : [ "string" ], "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+", "x-regex-name" : "picklistValue", "maxLength" : 120, "description" : "Category of the task" }, "description" : { "type" : [ "string" ], "maxLength" : 65535, "description" : "Description of the task" }, "teamId" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]*|null|undefined)", "x-regex-name" : "long_null", "description" : "Unique ID of the team to which the task is assigned" }, "reminder" : { "type" : [ "array" ], "items" : { "type" : [ "object" ], "properties" : { "reminderTime" : { "type" : [ "string" ], "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null", "x-regex-name" : "APIDateTime", "description" : "Time when the reminder must be triggered" }, "reminderType" : { "type" : [ "string" ], "enum" : [ "ABSOLUTE", "RELATIVE" ], "x-regex-name" : "reminderType", "description" : "Type of the reminder. Accepted values: ABSOLUTE, RELATIVE" }, "relativeReminderInMin" : { "type" : [ "integer" ], "format" : "int32", "description" : "Time offset in minutes before the task starts" }, "alertType" : { "type" : [ "array" ], "items" : { "type" : [ "string" ], "enum" : [ "EMAIL", "POPUP", "SMS" ] }, "x-template" : "alert_template", "description" : "Type of alert(s) related to the reminder. Accepted values: EMAIL, POPUP, SMS" } } }, "maxLength" : 10000, "description" : "Details of the reminder set for the task" }, "layoutId" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the layout associated with the task" } } } ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "subject" : "Bug Fix #120", "departmentId" : "3000000007043", "dueDate" : 1469117776000, "priority" : "High", "category" : null, "status" : "In Progress" } } } } } } }, "securitySchemes" : { "cookie-auth" : { "$ref" : "./Common.json#/components/securitySchemes/cookie-auth" }, "org-oauth" : { "$ref" : "./Common.json#/components/securitySchemes/org-oauth" }, "iam-oauth2-schema" : { "$ref" : "./Common.json#/components/securitySchemes/iam-oauth2-schema" }, "deprecated-iam-oauth2-schema" : { "$ref" : "./Common.json#/components/securitySchemes/deprecated-iam-oauth2-schema" } } }, "x-entity" : "Task" }