Query parameters

• page integer(int32)

  The page define the current page number. It should be positive integer number and should start with minimum value 1.

  Minimum value is 1.

• size integer(int32)

  The size define number of records on each page. It should be positive integer number between 1 to 10000.

  Minimum value is 1, maximum value is 10000.

• sort array[string]

  The sort parameter accepts an array of strings, allowing for multiple sorting criteria. By default, sorting order is ascending.

• name string

  The name parameter is an optional filter that allows you to narrow down the results based on specific name content.

• entityId string

  Filter Tasks based on the entityId.

• periodId string

  Filter Tasks based on the periodId. Period Id can be found using the api under period section which helps us to find the active periods.

• priority string

  Filter Tasks based on the priority. If not provided, considered all priority tasks. You can pass the values from ENUM: High, Medium, Low and Unspecified.

• critical string

  If critical set astrue, only critical tasks will be returned. Iffalse`, all tasks will be considered.

• taskTypeId string

  Filter Tasks based on the TaskTypeId. If not provided, considered all task types. You can fetch all ACTIVE Task Types using the api task-types under System Values section.

• taskId string

  Filter Tasks based on the taskId.

• status string

  Filter Tasks based on the status based on the enum defined.

• inboxId string

  Filter Tasks based on the inboxId.

• inboxUserIds string

  Filter Tasks based on a set of inboxId.

• inboxType string

  Filter Tasks based on the inboxType. Inbox Types can be U stands for User and Q stands for Queue.

• actionPlanIds string

  Filter Tasks based on the actionPlanIds. We can pass mutiple actionIds.

• dashboardRequest string

  Filter Tasks based on the dashboardRequest. dashboardRequest is by default false.

• isAssignedOnly string

  If set to true will return all assigned Tasks and If not, consider all the tasks which is assigned and not assigned.

• dashboardIdList string

  Filter Tasks based on the dashboardIdList. Multiple dashboardIds are allowed.

• descendantIds string

  Filter Tasks based on the descendantIds. Multiple descendantIds are allowed.

• viewableTDIds string

  Filter Tasks based on the viewableTDIds. Multiple viewableTDIds are allowed.

• include string

  Add include as CHILDREN for fetch tasks including the children details.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • result array[object]
    Hide result attributes Show result attributes object

    • id integer
    • logSid integer
    • name string
    • number string
    • wasCompletedLate boolean
    • currentAction string
    • period object
      Hide period attributes Show period attributes object

      • id integer
      • name string
      • statusId integer
      • year string
      • startDate string(date-time)
    • taskType object
      Hide taskType attributes Show taskType attributes object

      • id integer
      • systemValueGroupId integer
      • name string
      • shortName string
      • exportValue string
      • order integer
      • status string

        Values are ACTIVE, INACTIVE, DISABLED, NOT_STARTED, IN_PROGRESS, COMPLETE, or DELETED.

    • closeTaskDefinition object
      Hide closeTaskDefinition attributes Show closeTaskDefinition attributes object

      • id integer
      • parentId integer
      • name string
      • number string
      • description string
      • frequencyId integer
      • frequencyName string
      • status string

        Values are ACTIVE, INACTIVE, or DISABLED.

      • type string

        Values are ENTITY, CLOSE_TASK, or RECON_TASK.

      • entityId integer
      • entityName string
      • collaboration boolean
      • critical boolean
      • closePackage boolean
      • taskTypeId integer
      • taskTypeName string
      • attachmentRequired boolean
      • userDefinedFields array[object]
        Hide userDefinedFields attributes Show userDefinedFields attributes object

        • id integer
        • udfDefinitionId integer
        • value string
    • entityDefinitionId integer
    • entityName string
    • snapshotId integer
    • snapshotParentId integer
    • status object
      Hide status attributes Show status attributes object

      • id string
      • name string
    • dueDate string(date-time)
    • dateCompleted string(date-time)
    • inboxReceiverDto object
      Hide inboxReceiverDto attributes Show inboxReceiverDto attributes object

      • name string
      • type string
      • email string
      • queueId string
      • userName string
    • performer object
      Hide performer attributes Show performer attributes object

      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • performerDueDate string(date-time)
    • reviewer object
      Hide reviewer attributes Show reviewer attributes object

      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • reviewerDueDate string(date-time)
    • approver object
      Hide approver attributes Show approver attributes object

      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • approverDueDate string(date-time)
    • late boolean
  • metadata object

    Paging metadata dto.

    Hide metadata attributes Show metadata attributes object

    • totalElements integer(int64)

      The total number of rows in the result set.

    • totalPages integer(int32)

      The total number of pages in the result set, should = totalElements / size

    • first boolean

      True if this is the first page.

    • last boolean

      True if this is the last page.

    • empty boolean

      True if the result is empty.

    • numberOfElements integer(int32)

      The number of results in this page. Will be <= size.

    • size integer(int32)

      The page size.

    • sorted boolean

      True if the results are sorted.