Class CaseWorkflow

Hierarchy

  • CaseWorkflow

Properties

task

Methods - Comments

addTaskComment deleteTaskComments getCommentsForTask getCommentsForTasks updateTaskComment

Methods - Task Attachments

addTaskAttachment deleteTaskAttachment getTaskAttachments

Methods - Task Results

addTaskResult getResultsByTaskId searchForTaskResults

Methods - Tasks

addTask deleteTask deleteTasksOnCase getTasksByCaseId getTasksById searchForTasks setTaskResult updateTask

Properties

task

task: Object

Task sub-methods

Comments Methods

addTaskComment

  • Add Task Comment

    Returns

    Returns Promise that represents an object describing CaTaskCommentsItemBase.

    Parameters

    • caTaskId: number

      The Case task ID of the task to add the comment to

    • comment: string

      The comment text

    Returns Promise<unknown>

deleteTaskComments

  • Deletes tasks by TaskID

    Returns

    Returns Promise that represents a dictionary of comment IDs.

    Parameters

    • caTaskCommentIds: number[]

      The comments to delete

    Returns Promise<unknown>

getCommentsForTask

  • Search for CaseTaskComments by CaTaskId

    Returns

    Returns Promise that represents a collection of CommentRecords.

    Parameters

    • caTaskId: number

      The task ID for which to retrieve attached comments

    Returns Promise<unknown>

getCommentsForTasks

  • Search for CaseTaskComments by CaTaskId

    Returns

    Returns Promise that represents a collection of CaTaskCommentsItemBase.

    Parameters

    • caTaskIds: number[]

      The task IDs for which to retrieve attached comments

    Returns Promise<unknown>

updateTaskComment

  • Update Task Comment

    Returns

    Returns Promise that represents an object describing CaTaskCommentsItemBase.

    Parameters

    • caTaskCommentId: number

      The Case task ID of the task to add the comment to

    • comment: string

      The comment text

    • Optional commentId: number

      Probably unnecessary?

    Returns Promise<unknown>

Task Attachments Methods

addTaskAttachment

  • Adds a task to the case specified by the CaObectId.

    Returns

    Returns Promise that represents an object describing added Attachment

    Parameters

    • caTaskId: number

      The Task ID to attach the document to

    • caObjectId: number

      The Case Object ID

    • docName: number

      The file name as it should display in the system

    • file: any

      The binary string for the file

    • Optional locationType: string

      The location of the file...leave blank

    Returns Promise<unknown>

deleteTaskAttachment

  • Deletes a task attachment by caRelDocId (Related Case Document ID). Same as RelDocs delete for case.

    Returns

    Returns Promise that represents the an object describing the deleted document.

    Parameters

    • caRelDocId: number

      The caRelDocId for the related document which should be deleted

    Returns Promise<unknown>

getTaskAttachments

  • Gets each Document Attached to the specified Task

    Returns

    Returns Promise that represents a collection of objects describing each Attachment on the provided task

    Parameters

    • caTaskId: number

      The Task ID to attach the document to

    Returns Promise<unknown>

Task Results Methods

addTaskResult

  • Add Task Result

    Returns

    Returns Promise that represents an object describing CaTaskResultsItem.

    Parameters

    • caObjectId: number

      The Case Object to attach the task to

    • caTaskId: number

      The Case task ID to add the result to

    • resultCode: number

      The result Code

    • resultID: number

      The result ID

    • resultSetID: number

      The result set ID

    • Optional options: Object

      Options for the Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTaskResults

    Returns Promise<unknown>

getResultsByTaskId

  • Get CaTaskResultsItem by CaTaskIds

    Returns

    Returns Promise that represents a collection of CaTaskResultsItems.

    Parameters

    • caTaskIds: number[]

      The IDs of the tasks for which to retrieve results

    Returns Promise<unknown>

searchForTaskResults

  • Search for CaseTaskResults Objects. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields

    Returns

    Returns Promise that represents a collection of resulting CaTaskResultsItem

    Parameters

    • Optional filters: Object

      The parameters to search by. See: /{subdirectory}/apidocs/#/service-info/Pll/CaseTaskResults

    Returns Promise<unknown>

Tasks Methods

addTask

  • Adds a task to the case specified by the CaObectId.

    Returns

    Returns Promise that represents an object describing CaTaskItemBase.

    Parameters

    • caObjectId: number

      The Case Object to attach the task to

    • taskId: number

      The task ID to add to the case workflow

    • startPoint: number

      The start point in the workflow for the task

    • endPoint: number

      The end point in the workflow for the task

    • Optional options: Object

      Options for the Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask

    Returns Promise<unknown>

deleteTask

  • Deletes a task by TaskID

    Returns

    Returns Promise that represents an object describing CaTaskItemBase.

    Parameters

    • caTaskId: number

      The caTaskId for the task which should be deleted

    Returns Promise<unknown>

deleteTasksOnCase

  • Deletes a task by TaskID

    Returns

    Returns Promise that represents the number of the CaObjectID

    Parameters

    • caObjectId: number

    Returns Promise<unknown>

getTasksByCaseId

  • Get tasks by CaObjectId

    Returns

    Returns Promise that represents a collection of the CaTaskItemBases.

    Parameters

    • caObjectId: number

      The Case Object to get the attached tasks

    • checkRelatedItems: boolean = false

      Wherther to check related items. Defaults to false.

    Returns Promise<unknown>

getTasksById

  • Get tasks by TaskIds

    Returns

    Returns Promise that represents a collection of the CaTaskItemBases.

    Parameters

    • caTaskIds: number[]

      The IDs of the tasks to retrieve

    • checkRelatedItems: boolean = false

      Wherther to check related items. Defaults to false.

    Returns Promise<unknown>

searchForTasks

  • Search for Case Tasks. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields

    Returns

    Returns Promise that represents a collection of resulting CaTaskIDs

    Parameters

    • Optional filters: Object

      The parameters to search by. (ResponsibleUserId, TaskAvailable, TaskComplete, TaskType)

    Returns Promise<unknown>

setTaskResult

  • Updates a task

    Returns

    Returns Promise that represents an object describing CaTaskItemBase.

    Parameters

    • caTaskId: number

      The Case Object to attach the task to

    • resultCode: string

      The result code to set for the specified Task

    • Optional options: Object

      Options for Task. Specify either or both TaskCompletedBy & TaskCompleteDate. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask

    Returns Promise<unknown>

updateTask

  • Updates a task

    Returns

    Returns Promise that represents an object describing CaTaskItemBase.

    Parameters

    • caTaskId: number

      The Case Object to attach the task to

    • Optional options: Object

      Options for Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask

    Returns Promise<unknown>

Settings

Member Visibility

Theme