Get Work Items

Get Work Items

Returns work items for the logged in user

Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/workitem/api/workitems
COPY
Query Parameters
string
state
Optional

state

Possible values are : ACTIVE, ANSWERED, REJECTED, EXPIRED,
string
assigneeState
Optional

assigneeState

Possible values are : PENDING, ANSWERED, REJECTED,
string
type
Optional

type

string
search
Optional

Searching is enabled on following attributes: deploymentName, work item name and workflow details

integer
page
Optional

Results page you want to retrieve (0..N)

integer
size
Optional

Number of records per page.

string
sort
Optional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending.

Header Parameters
string
Accept
Optional

Accept

Authentication
This operation uses the following authentication methods.
Responses
200

Success - returns work items for the logged in user

Returns PageWorkItem of type(s) application/json 
{
    "content": [
        {
            "actionedAt": "string",
            "actionedBy": "string",
            "assignees": [
                {
                    "id": "string",
                    "type": "string"
                }
            ],
            "callbackURL": "string",
            "createdAt": "string",
            "deploymentId": "string",
            "deploymentName": "string",
            "description": "string",
            "details": {
                "details": {}
            },
            "expiryAt": "string",
            "id": "string",
            "lastUpdatedAt": "string",
            "name": "string",
            "orgId": "string",
            "projectId": "string",
            "projectName": "string",
            "requestId": "string",
            "requestedBy": "string",
            "state": "string",
            "type": "string",
            "workItemDetails": {
                "formDetails": {
                    "formDetails": {}
                },
                "workItemData": {
                    "workItemData": {}
                }
            },
            "workflowDetails": {
                "id": "string",
                "muiId": "string",
                "name": "string",
                "runId": "string"
            }
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "pageable": {
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "paged": false,
        "sort": [
            {
                "ascending": false,
                "direction": "string",
                "ignoreCase": false,
                "nullHandling": "string",
                "property": "string"
            }
        ],
        "unpaged": false
    },
    "size": 0,
    "sort": [
        {
            "ascending": false,
            "direction": "string",
            "ignoreCase": false,
            "nullHandling": "string",
            "property": "string"
        }
    ],
    "totalElements": 0,
    "totalPages": 0
}
array of object
content
Optional

content

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

object
pageable
Optional

pageable

integer As int32 As int32
size
Optional

size

array of object
sort
Optional

sort

integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/workitem/api/workitems
On This Page
Work Item Service Operations
GET
Get Work Items
GET
Get Work Items For Deployment
GET
Get Work Items For Deployment Request
GET
Get Work Item By Id
POST
Answer Work Item
POST
Reject Work Item