GET api/OmsScheduleManagement/schedule-history

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional Information
Filters		Collection of ScheduleHistoryFilter	None.

Request Formats

application/json, text/json

Sample:

{
  "Filters": [
    {
      "FilterName": "sample string 1",
      "FilterValue": "sample string 2"
    },
    {
      "FilterName": "sample string 1",
      "FilterValue": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<GetScheduleHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <Filters xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
    <d2p1:ScheduleHistoryFilter>
      <d2p1:FilterName>sample string 1</d2p1:FilterName>
      <d2p1:FilterValue>sample string 2</d2p1:FilterValue>
    </d2p1:ScheduleHistoryFilter>
    <d2p1:ScheduleHistoryFilter>
      <d2p1:FilterName>sample string 1</d2p1:FilterName>
      <d2p1:FilterValue>sample string 2</d2p1:FilterValue>
    </d2p1:ScheduleHistoryFilter>
  </Filters>
</GetScheduleHistoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetScheduleHistoryResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.
Model	ScheduleHistoryModel	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Model": {
    "ScheduleManagementModels": [
      {
        "JobCode": "sample string 1",
        "JobType": "sample string 2",
        "IsReadOnly": true,
        "ScheduleID": 4,
        "MinuteRecurrenceInterval": 5,
        "AbandonMinutes": 6,
        "NextRun": "2025-12-20T20:52:20.5704439+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-20T20:52:20.5704439+00:00",
        "History": null,
        "ShouldWarnUser": true,
        "IsRunning": true
      }
    ],
    "ReportTime": "2025-12-20T20:52:20.5704439+00:00",
    "ScheduleHistoryFilters": [
      {
        "FilterName": "sample string 1",
        "FilterValue": "sample string 2"
      },
      {
        "FilterName": "sample string 1",
        "FilterValue": "sample string 2"
      }
    ],
    "EnableExport": true
  }
}

application/xml, text/xml

Sample:

<GetScheduleHistoryResponse 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>
  <Message>sample string 1</Message>
  <Model xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
    <d2p1:EnableExport>true</d2p1:EnableExport>
    <d2p1:ReportTime>2025-12-20T20:52:20.5704439+00:00</d2p1:ReportTime>
    <d2p1:ScheduleHistoryFilters>
      <d2p1:ScheduleHistoryFilter>
        <d2p1:FilterName>sample string 1</d2p1:FilterName>
        <d2p1:FilterValue>sample string 2</d2p1:FilterValue>
      </d2p1:ScheduleHistoryFilter>
      <d2p1:ScheduleHistoryFilter>
        <d2p1:FilterName>sample string 1</d2p1:FilterName>
        <d2p1:FilterValue>sample string 2</d2p1:FilterValue>
      </d2p1:ScheduleHistoryFilter>
    </d2p1:ScheduleHistoryFilters>
    <d2p1:ScheduleManagementModels>
      <d2p1:ScheduleManagementModel>
        <d2p1:AbandonMinutes>6</d2p1:AbandonMinutes>
        <d2p1:History xmlns:d5p1="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-20T20:52:20.5704439+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:d5p1="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-20T20:52:20.5704439+00:00</d2p1:NextRun>
        <d2p1:ScheduleID>4</d2p1:ScheduleID>
        <d2p1:ShouldWarnUser>true</d2p1:ShouldWarnUser>
      </d2p1:ScheduleManagementModel>
    </d2p1:ScheduleManagementModels>
  </Model>
  <ResponseCode>Success</ResponseCode>
</GetScheduleHistoryResponse>