Powered by Redocly

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=E.g. 1
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Request Body schema: application/json
required

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
application/json
{
  • "owner": "admin",
  • "summary": "Summary for the task",
  • "priority": "MEDIUM",
  • "type": "MISCELLANEOUS",
  • "details": "Details of the task"
}

Get Tasks based on the 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=E.g. 1
inventoryId
integer <int32>

ID of the inventory to be used in search

Example: inventoryId=E.g. 1
offset
integer <int32>
Default: 1

Index of the page to start with

Example: offset=E.g. 1 | default: 1
limit
integer <int32>
Default: 25

Number Of Records to fetch

Example: limit=E.g. 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: E.g. Bearer JWT_TOKEN
Responses
200

OK

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: E.g. 1
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Responses
200

OK

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: E.g. 1
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Request Body schema: application/json
required

Update existing workflow task
priority :"LOW, MEDIUM, HIGH"

summary
string

summary

priority
string

priority

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

details

Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/tasks/{taskId}
Request samples
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: E.g. 1
query Parameters
resolution
required
string
Default: "CLOSED"
Enum: "CLOSED" "APPROVED" "REJECTED"
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Responses
200

OK

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: E.g. 1
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Request Body schema: application/json
required

Map alm Issues to workflow task

ids
required
Array of integers <int32>

almIssueId

Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

post/tasks/{taskId}/issues
Request samples
application/json
{
  • "ids": [
    ]
}

Reassign Task

Reassign Task

Request
path Parameters
taskId
required
integer <int32>

ID of the task to be reassigned

Example: E.g. 1
query Parameters
ownerId
required
string

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

Example: ownerId=E.g. admin
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/tasks/{taskId}/reassign
➔ Next to User API