GET api/consumer/v1/workspaces/{workspaceId}/jobs/{jobId}
Get job by Id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| workspaceId |
WorkspaceId |
integer |
Required |
| jobId |
Id of the Job |
integer |
Required |
Body Parameters
None
Response Information
Resource Description
List of found jobs
WorkspaceJobDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Workspace |
Workspace of element |
WorkspaceMinDto |
None |
| JobType |
Type of element |
WorkspaceJobTypeMinDto |
None |
| StartDate |
Start date of element |
DateDto |
None |
| EndDate |
End date of element |
DateDto |
None |
| Position |
Sort order |
integer |
None |
| IsArchived |
True if the job is archived |
boolean |
None |
| Cards |
Cards Summary (optional, not always populated) |
WorkspaceJobCardSummaryDto |
None |
| Code |
The short code of the element |
string |
None |
| Description |
The description of the element |
string |
None |
| IsActive |
True if the element is active, false otherwise |
boolean |
None |
| Permissions |
Permissions |
PermissionDto |
None |
| CreationDate |
Creation |
date |
None |
| CreatedBy |
The user who has made the insert |
UserMinDto |
None |
| LastUpdateDate |
Date of the last update |
date |
None |
| LastUpdatedBy |
The user who has made the last update |
UserMinDto |
None |
| Id |
Unique ID |
integer |
None |
Response Formats
application/json, text/json
Sample:
{
"Workspace": {
"Code": "sample string 1",
"Id": 2
},
"JobType": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"StartDate": null,
"EndDate": null,
"Position": 1,
"IsArchived": true,
"Cards": {
"Total": 1,
"Archived": 2,
"Assigned": 3,
"Unassigned": 4,
"MyAssigned": 5
},
"Code": "sample string 3",
"Description": "sample string 4",
"IsActive": true,
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"CreationDate": "2024-11-01T19:43:50.8060514+01:00",
"CreatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastUpdateDate": "2024-11-01T19:43:50.8060514+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 6
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.