Skip to content

TaskAssignments.md

Latest commit

 

History

History
163 lines (99 loc) · 4.27 KB

TaskAssignments.md

File metadata and controls

163 lines (99 loc) · 4.27 KB

TaskAssignmentsManager

List task assignments

Lists all of the assignments for a given task.

This operation is performed by calling function getTaskAssignments.

See the endpoint docs at API Reference.

try await client.taskAssignments.getTaskAssignments(taskId: task.id!)

Arguments

  • taskId String
    • The ID of the task. Example: "12345"
  • headers GetTaskAssignmentsHeaders
    • Headers of getTaskAssignments method

Returns

This function returns a value of type TaskAssignments.

Returns a collection of task assignment defining what task on a file has been assigned to which users and by who.

Assign task

Assigns a task to a user.

A task can be assigned to more than one user by creating multiple assignments.

This operation is performed by calling function createTaskAssignment.

See the endpoint docs at API Reference.

try await client.taskAssignments.createTaskAssignment(requestBody: CreateTaskAssignmentRequestBody(task: CreateTaskAssignmentRequestBodyTaskField(type: CreateTaskAssignmentRequestBodyTaskTypeField.task, id: task.id!), assignTo: CreateTaskAssignmentRequestBodyAssignToField(id: currentUser.id)))

Arguments

  • requestBody CreateTaskAssignmentRequestBody
    • Request body of createTaskAssignment method
  • headers CreateTaskAssignmentHeaders
    • Headers of createTaskAssignment method

Returns

This function returns a value of type TaskAssignment.

Returns a new task assignment object.

Get task assignment

Retrieves information about a task assignment.

This operation is performed by calling function getTaskAssignmentById.

See the endpoint docs at API Reference.

try await client.taskAssignments.getTaskAssignmentById(taskAssignmentId: taskAssignment.id!)

Arguments

  • taskAssignmentId String
    • The ID of the task assignment. Example: "12345"
  • headers GetTaskAssignmentByIdHeaders
    • Headers of getTaskAssignmentById method

Returns

This function returns a value of type TaskAssignment.

Returns a task assignment, specifying who the task has been assigned to and by whom.

Update task assignment

Updates a task assignment. This endpoint can be used to update the state of a task assigned to a user.

This operation is performed by calling function updateTaskAssignmentById.

See the endpoint docs at API Reference.

try await client.taskAssignments.updateTaskAssignmentById(taskAssignmentId: taskAssignment.id!, requestBody: UpdateTaskAssignmentByIdRequestBody(message: "updated message", resolutionState: UpdateTaskAssignmentByIdRequestBodyResolutionStateField.approved))

Arguments

  • taskAssignmentId String
    • The ID of the task assignment. Example: "12345"
  • requestBody UpdateTaskAssignmentByIdRequestBody
    • Request body of updateTaskAssignmentById method
  • headers UpdateTaskAssignmentByIdHeaders
    • Headers of updateTaskAssignmentById method

Returns

This function returns a value of type TaskAssignment.

Returns the updated task assignment object.

Unassign task

Deletes a specific task assignment.

This operation is performed by calling function deleteTaskAssignmentById.

See the endpoint docs at API Reference.

try await client.taskAssignments.deleteTaskAssignmentById(taskAssignmentId: taskAssignment.id!)

Arguments

  • taskAssignmentId String
    • The ID of the task assignment. Example: "12345"
  • headers DeleteTaskAssignmentByIdHeaders
    • Headers of deleteTaskAssignmentById method

Returns

This function returns a value of type ``.

Returns an empty response when the task assignment was successfully deleted.