POST api/OmsScheduleManagement/run-schedule

Request Information

URI Parameters

None.

Body Parameters

RunJobFeedRequest

NameDescriptionTypeAdditional Information
JobType

string

None.

JobCode

string

None.

WasWarned

boolean

None.

AbandonMinutes

integer

None.

ScheduleId

integer

None.

UserName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "JobType": "sample string 1",
  "JobCode": "sample string 2",
  "WasWarned": true,
  "AbandonMinutes": 4,
  "ScheduleId": 5,
  "UserName": "sample string 6"
}

application/xml, text/xml

Sample:
<RunJobFeedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <AbandonMinutes>4</AbandonMinutes>
  <JobCode>sample string 2</JobCode>
  <JobType>sample string 1</JobType>
  <ScheduleId>5</ScheduleId>
  <UserName>sample string 6</UserName>
  <WasWarned>true</WasWarned>
</RunJobFeedRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RunJobFeedResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.

Message

string

None.

CorrelationId

string

None.

IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "IsSuccess": true
}

application/xml, text/xml

Sample:
<RunJobFeedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId>sample string 2</CorrelationId>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</RunJobFeedResponse>