Tasks Search - AcceleratorKMS - Version 5.0 - Help - Hexagon

Authorization

bearer <token>

Actual token value acquired from the authentication step

Content-Type

application/json

Designates the POST’s content response as JSON format

ProcedureTitle

String

Represents the content title or content request title

CompletionStatus

Integer

The status of the task, which can be

• -1 = All

• 0 = Incomplete

• 1 = Completed

ContentType

String

The identifier (GUID) of the Content Type.

AssetId

String

The unique identifier of asset. For example, PU-123.

ProcedureStatus

Integer

The status of the content of the task, which can be

• -1 = All

• 0 = Draft

• 1 = Published

Workflow

String

The identifier (GUID) of the workflow.

TaskType

String

The identifier (GUID) of the applicable task's node in a workflow.

AssignedTo

String

Username identifying the user to whom the task is assigned.

AssignedDateLowerRange

Date

Earliest date on which tasks were assigned; format is YYYY-MM- DD

AssignedDateUpperRange

Date

Latest date on which tasks were created; format is YYYY-MM-DD

CreatedBy

String

Username identifying the user who created the task.

CreatedDateLowerRange

Date

Earliest date on which tasks were created; format is YYYY-MM- DD

When no date filters are applied, the query returns the results 6 months before today's date.

CreatedDateUpperRange

Date

Latest date on which tasks were created; format is YYYY-MM-DD

TaskDueDateLowerRange

Date

Earliest date on which tasks are due; format is YYYY-MM-DD

TaskDueDateUpperRange

Date

Latest date on which tasks are due; format is YYYY-MM-DD

ModifiedDateLowerRange

Date

Earliest date on which tasks were modified; format is YYYY-MM- DD

ModifiedDateUpperRange

Date

Latest date on which tasks were modified; format is YYYY-MM-DD

LimitResults

Integer

Represents the number of results to return.

IsReportable

Boolean

Set to False to receive tasks for non-reportable workflows. When not included in search criteria, reportable tasks are returned in the results. To obtain both reportable and non-reportable tasks, two individual queries must be run.

Domain

String

The identifier (GUID) of the Domain node.

Content = Text.ToBinary("{""ProcedureTitle"":""}")

Returns all tasks created within the last six months

Content = Text.ToBinary("{""ProcedureTitle"":""shutdown""}")

Returns all tasks created within the last six months for content where the title includes the term “shutdown”

Content = Text.ToBinary("{""ProcedureTitle"":""shutdown"", ""LimitResults"":10}")

Returns first 10 tasks created within the last six months for content where the title includes the term “shutdown”

Content = Text.ToBinary("{""ProcedureTitle"":"" shutdown"", ""LimitResults"":10, ""CreatedDateLowerRange"":""2020-01-01""}")

Returns first 10 tasks created after first day of 2020 for content where the title includes the term “shutdown”

Content = Text.ToBinary("{""ProcedureTitle"":"" shutdown"", ""LimitResults"":10, ""ModifiedDateLowerRange"":""2020-01-01""}")

Returns first 10 tasks modified after first day of 2020 for content where the title includes the term “shutdown”

Content = Text.ToBinary("{""ProcedureTitle"":"" shutdown"", ""LimitResults"":10, ""CompletionStatus"":0, ""ModifiedDateLowerRange"":""2018-02-07"", ""ModifiedDateUpperRange"":""2020-01-31"", ""TaskDueDateLowerRange"":""2019-12-25"", ""TaskDueDateUpperRange"":""2020-01-31""}")

Returns first 10 tasks for:

• Content where title includes the term "shutdown"

• Tasks status is Incomplete

• Task modified date is between February 7, 2018 and January 1, 2020

• Task due date is between December 25, 2019 and January 31, 2020

If a date is not specified in the parameters, then by default the CreatedDateLowerRange parameter is set to six months before today.