PUT api/external/v1/RunJob
Request Information
URI Parameters
None.
Body Parameters
Collection of SFE.Common.PublicEntities.RunJobVMName | Description | Type | Additional information |
---|---|---|---|
Id | SFE.Common.Enumerations.JobKind |
None. |
|
Text | string |
None. |
|
Category | SFE.Common.Enumerations.JobCategory |
None. |
|
CategoryText | string |
None. |
|
From | date |
None. |
|
FromTZOffset | integer |
None. |
|
To | date |
None. |
|
ToTZOffset | integer |
None. |
|
HasUser | boolean |
None. |
|
HasDepartment | boolean |
None. |
|
Status | SFE.Common.Enumerations.JobStatus |
None. |
|
StatusText | string |
None. |
|
ErrorText | string |
None. |
|
Department | string |
None. |
|
User | string |
None. |
|
LastCall | date |
None. |
|
RanFor | integer |
None. |
|
Parameter1 | integer |
None. |
|
Parameter2 | string |
None. |
|
Parameter3 | integer |
None. |
|
Parameter4 | string |
None. |
Request Formats
application/json, text/json
Sample:
[ { "id": 10, "text": "SignOut", "category": 1, "categoryText": "Production", "from": "2024-11-15T03:43:01.4506459Z", "fromTZOffset": 1, "to": "2024-11-15T03:43:01.4506459Z", "toTZOffset": 2, "hasUser": true, "hasDepartment": true, "status": 0, "statusText": "Ready", "errorText": "sample string 5", "department": "sample string 6", "user": "sample string 7", "lastCall": "2024-11-15T03:43:01.4506459Z", "ranFor": 1, "parameter1": 8, "parameter2": "sample string 9", "parameter3": 10, "parameter4": "sample string 11" }, { "id": 10, "text": "SignOut", "category": 1, "categoryText": "Production", "from": "2024-11-15T03:43:01.4506459Z", "fromTZOffset": 1, "to": "2024-11-15T03:43:01.4506459Z", "toTZOffset": 2, "hasUser": true, "hasDepartment": true, "status": 0, "statusText": "Ready", "errorText": "sample string 5", "department": "sample string 6", "user": "sample string 7", "lastCall": "2024-11-15T03:43:01.4506459Z", "ranFor": 1, "parameter1": 8, "parameter2": "sample string 9", "parameter3": 10, "parameter4": "sample string 11" } ]
application/xml, text/xml
Sample:
<ArrayOfRunJobVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFE.Common.PublicEntities"> <RunJobVM> <Category>Production</Category> <Department>sample string 6</Department> <ErrorText>sample string 5</ErrorText> <From>2024-11-14T23:43:01.4506459-04:00</From> <FromTZOffset>1</FromTZOffset> <HasDepartment>true</HasDepartment> <HasUser>true</HasUser> <Id>SignOut</Id> <LastCall>2024-11-14T23:43:01.4506459-04:00</LastCall> <Parameter1>8</Parameter1> <Parameter2>sample string 9</Parameter2> <Parameter3>10</Parameter3> <Parameter4>sample string 11</Parameter4> <RanFor>1</RanFor> <Status>Ready</Status> <To>2024-11-14T23:43:01.4506459-04:00</To> <ToTZOffset>2</ToTZOffset> <User>sample string 7</User> </RunJobVM> <RunJobVM> <Category>Production</Category> <Department>sample string 6</Department> <ErrorText>sample string 5</ErrorText> <From>2024-11-14T23:43:01.4506459-04:00</From> <FromTZOffset>1</FromTZOffset> <HasDepartment>true</HasDepartment> <HasUser>true</HasUser> <Id>SignOut</Id> <LastCall>2024-11-14T23:43:01.4506459-04:00</LastCall> <Parameter1>8</Parameter1> <Parameter2>sample string 9</Parameter2> <Parameter3>10</Parameter3> <Parameter4>sample string 11</Parameter4> <RanFor>1</RanFor> <Status>Ready</Status> <To>2024-11-14T23:43:01.4506459-04:00</To> <ToTZOffset>2</ToTZOffset> <User>sample string 7</User> </RunJobVM> </ArrayOfRunJobVM>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.