PUT api/consumer/v1/workspaces/{workspaceId}/jobs/{jobId}
Update an existing job workspace
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| workspaceId |
ID of the workspace |
integer |
Required |
| jobId |
Job ID |
integer |
Required |
Body Parameters
New job workspace informations
WorkspaceJobEditDto| Name | Description | Type | Additional information |
|---|---|---|---|
| JobTypeId |
Type of the workspace (1 or 2) |
integer |
None |
| StartDate |
The start date |
date |
None |
| EndDate |
The end date |
date |
None |
| Position |
Display sort order (-1 for last) |
integer |
None |
| IsArchived |
True if the job is archived |
boolean |
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:
{
"JobTypeId": 1,
"StartDate": "2024-11-01T16:37:16.168604+01:00",
"EndDate": "2024-11-01T16:37:16.168604+01:00",
"Position": 2,
"IsArchived": true,
"Code": "sample string 4",
"Description": "sample string 5",
"IsActive": true,
"Id": 7
}
application/xml, text/xml
Sample:
<WorkspaceJobEditDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models"> <Id>7</Id> <Code>sample string 4</Code> <Description>sample string 5</Description> <IsActive>true</IsActive> <EndDate>2024-11-01T16:37:16.168604+01:00</EndDate> <IsArchived>true</IsArchived> <JobTypeId>1</JobTypeId> <Position>2</Position> <StartDate>2024-11-01T16:37:16.168604+01:00</StartDate> </WorkspaceJobEditDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
200
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 |