Query parameters

• entityDefinitionId string

  The identifier of the entity definition. Only task definitions defined for the specified entity definition will be returned if active and accessible to current user.

• fetchDepth integer(int32)

  Governs if child task definitions are loaded and, if so, how deeply we traverse the tree. If not provided, we do not load child task definitions.

  Minimum value is 0, maximum value is 5.

• 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.

Responses

• 200 application/json

  The requested page of entities.

  Hide response attributes Show response attributes object

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

    • id integer
    • parentId integer
    • name string
    • number string
    • description string
    • instructions string
    • isCritical boolean
    • entity object
      Hide entity attributes Show entity attributes object

      • id object
      • name string
    • performer object
      Hide performer attributes Show performer attributes object

      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • reviewer object
      Hide reviewer attributes Show reviewer attributes object

      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • approver object
      Hide approver attributes Show approver attributes object

      • id integer
      • name string
      • email string
      • userName string
      • first string
      • middle string
      • last string
    • children array[object]
      Hide children attributes Show children attributes object

      • id object
      • name string
  • 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.