GET api/OmsScheduleManagement/schedules

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.
Schedules	Collection of ScheduleManagementModel	None.
EnableExport	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Schedules": [
    {
      "JobCode": "sample string 1",
      "JobType": "sample string 2",
      "IsReadOnly": true,
      "ScheduleID": 4,
      "MinuteRecurrenceInterval": 5,
      "AbandonMinutes": 6,
      "NextRun": "2025-12-20T23:44:00.8807963+00:00",
      "History": null,
      "ShouldWarnUser": true,
      "IsRunning": true
    },
    {
      "JobCode": "sample string 1",
      "JobType": "sample string 2",
      "IsReadOnly": true,
      "ScheduleID": 4,
      "MinuteRecurrenceInterval": 5,
      "AbandonMinutes": 6,
      "NextRun": "2025-12-20T23:44:00.8807963+00:00",
      "History": null,
      "ShouldWarnUser": true,
      "IsRunning": true
    }
  ],
  "EnableExport": true
}

application/xml, text/xml

Sample:

<ScheduleManagementModelResponse 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>
  <EnableExport>true</EnableExport>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
  <Schedules xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
    <d2p1:ScheduleManagementModel>
      <d2p1:AbandonMinutes>6</d2p1:AbandonMinutes>
      <d2p1:History xmlns:d4p1="http://schemas.datacontract.org/2004/07/DECK.Core.Domain.Models" i:nil="true" />
      <d2p1:IsReadOnly>true</d2p1:IsReadOnly>
      <d2p1:IsRunning>true</d2p1:IsRunning>
      <d2p1:JobCode>sample string 1</d2p1:JobCode>
      <d2p1:JobType>sample string 2</d2p1:JobType>
      <d2p1:MinuteRecurrenceInterval>5</d2p1:MinuteRecurrenceInterval>
      <d2p1:NextRun>2025-12-20T23:44:00.8807963+00:00</d2p1:NextRun>
      <d2p1:ScheduleID>4</d2p1:ScheduleID>
      <d2p1:ShouldWarnUser>true</d2p1:ShouldWarnUser>
    </d2p1:ScheduleManagementModel>
    <d2p1:ScheduleManagementModel>
      <d2p1:AbandonMinutes>6</d2p1:AbandonMinutes>
      <d2p1:History xmlns:d4p1="http://schemas.datacontract.org/2004/07/DECK.Core.Domain.Models" i:nil="true" />
      <d2p1:IsReadOnly>true</d2p1:IsReadOnly>
      <d2p1:IsRunning>true</d2p1:IsRunning>
      <d2p1:JobCode>sample string 1</d2p1:JobCode>
      <d2p1:JobType>sample string 2</d2p1:JobType>
      <d2p1:MinuteRecurrenceInterval>5</d2p1:MinuteRecurrenceInterval>
      <d2p1:NextRun>2025-12-20T23:44:00.8807963+00:00</d2p1:NextRun>
      <d2p1:ScheduleID>4</d2p1:ScheduleID>
      <d2p1:ShouldWarnUser>true</d2p1:ShouldWarnUser>
    </d2p1:ScheduleManagementModel>
  </Schedules>
</ScheduleManagementModelResponse>