POST api/consumer/v1/workspaces/{workspaceId}/jobs/{jobId}/lists
Add a new Job List
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| workspaceId |
WorkspaceId |
integer |
Required |
| jobId |
Job ID |
integer |
Required |
Body Parameters
New workspace Job information
WorkspaceJobListEditDto| Name | Description | Type | Additional information |
|---|---|---|---|
| JobId |
Job ID |
integer |
None |
| Position |
Display sort order (-1 for last) |
integer |
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 |
| Id |
Unique ID |
integer |
None |
Request Formats
application/json, text/json
Sample:
{
"JobId": 1,
"Position": 2,
"Code": "sample string 3",
"Description": "sample string 4",
"IsActive": true,
"Id": 6
}
application/xml, text/xml
Sample:
<WorkspaceJobListEditDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models"> <Id>6</Id> <Code>sample string 3</Code> <Description>sample string 4</Description> <IsActive>true</IsActive> <JobId>1</JobId> <Position>2</Position> </WorkspaceJobListEditDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
New job list
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None |
|
| Content | HttpContent |
None |
|
| StatusCode | HttpStatusCode |
None |
|
| ReasonPhrase | string |
None |
|
| Headers | Collection of Object |
None |
|
| RequestMessage | HttpRequestMessage |
None |
|
| IsSuccessStatusCode | boolean |
None |