Task

Create Task

Create task.

Request

query Parameters

inventoryId

required

integer <int32>

ID of the inventory to be used to create the task.

Example: inventoryId=1

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Request Body schema: application/json

Create new workflow task.

priority: LOW, MEDIUM, HIGH
type: MISCELLANEOUS, MANUAL_INVENTORY_REVIEW, REMEDIATE_INVENTORY

owner	string owner
summary	string summary
priority	string priority Enum: "LOW" "MEDIUM" "HIGH"
type	string type Enum: "MISCELLANEOUS" "MANUAL_INVENTORY_REVIEW" "REMEDIATE_INVENTORY"
details	string details

Responses

201

Created

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/tasks

Request samples

Payload

application/json

{"owner": "admin",
"summary": "Summary for the task",
"priority": "MEDIUM",
"type": "MISCELLANEOUS",
"details": "Details of the task"
}

Get Tasks Based on Search Terms

Return tasks associated with the search term.

Request

query Parameters

projectId	integer <int32> ID of the project to be used in search. Example: projectId=1
inventoryId	integer <int32> ID of the inventory item to be used in search. Example: inventoryId=1
offset	integer <int32> Default: 1 Index of the page to start with. Example: offset=1 \| default: 1
limit	integer <int32> Default: 25 Number Of Records to fetch Example: limit=25 \| default: 25
status	string Default: "ALL" Status of the task to be used in search. Enum: "OPEN" "CLOSED"
type	string Default: "ALL" Type of the task to be used in search. Enum: "MISCELLANEOUS" "MANUAL_INVENTORY_REVIEW" "REMEDIATE_INVENTORY" "ALL"
priority	string Default: "ALL" Priority of the task to be used in search. Enum: "LOW" "MEDIUM" "HIGH"

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/tasks/search

Get Task

Get task.

Request

path Parameters

taskId

required

integer <int32>

ID of the task to be fetched.

Example: 1

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/tasks/{taskId}

Update Task

Update task.

Request

path Parameters

taskId

required

integer <int32>

ID of the task to be updated.

Example: 1

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Request Body schema: application/json

Update existing workflow task.

priority: LOW, MEDIUM, HIGH

summary	string summary
priority	string priority Enum: "LOW" "MEDIUM" "HIGH"
details	string details

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/tasks/{taskId}

Request samples

Payload

application/json

{"summary": "Summary for the task",
"priority": "MEDIUM",
"details": "Details of the task"
}

Close Task

Close task.

Request

path Parameters

taskId

required

integer <int32>

ID of the task to be closed.

Example: 1

query Parameters

resolution

required

string

Default: "CLOSED"

Enum: "CLOSED" "APPROVED" "REJECTED"

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/tasks/{taskId}/close

Assign ALM Issues

Assign ALM issues to task.

Request

path Parameters

taskId

required

integer <int32>

ID of the task to be updated.

Example: 1

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Request Body schema: application/json

Map ALM Issues to workflow task.

ids

required

Array of integers <int32>

almIssueId

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

post/tasks/{taskId}/issues

Request samples

Payload

application/json

{"ids": [0
]
}

Reassign Task

Reassign task.

Request

path Parameters

taskId

required

integer <int32>

ID of the task to be reassigned.

Example: 1

query Parameters

ownerId

required

string

ID / Name of the owner to whom the task needs to be reassigned.

Example: ownerId=admin

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/tasks/{taskId}/reassign

➔ Next to User API