GET api/Schedules/{id}?subLevels={subLevels}
Get a specific Schedule by ID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID of the Schedule |
integer |
Required |
| subLevels |
Levels to include under this object, as applicable. -1 (the default) returns all sublevels. |
integer |
Default value is -1 |
Body Parameters
None.
Response Information
Resource Description
GetScheduleResponse object
GetSchedulesResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Schedules |
Array of Schedules |
Collection of Schedule |
None. |
| Messages |
Array of messages |
Collection of Message |
None. |
| ServerInformation |
Relevant information regarding the Server |
ServerInformation |
None. |
| VersionInformation |
Relevant information regarding the API's version |
VersionInformation |
None. |
Response Formats
application/json, text/json, text/html
Sample:
{
"Schedules": [
{
"ID": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"StartDate": "2025-11-09T21:36:43.9223311+10:00",
"FinishDate": "2025-11-09T21:36:43.9223311+10:00",
"Progress": 6.1,
"ApprovedDate": "2025-11-09T21:36:43.9223311+10:00",
"ApprovedBy": 7,
"CancelledDate": "2025-11-09T21:36:43.9223311+10:00",
"CancelledBy": 8,
"Status": 1,
"Message": "sample string 9",
"Editable": true,
"Settings": {
"AutoCancel": true,
"HaltQueueOnError": true,
"CommandRetryLimit": 1,
"ResendOnError": true,
"ResendOnErrorLimit": 1,
"ResendOnErrorCount": 1,
"AllowStartDateAdjustment": true,
"SendPeriod": "00:00:00.1234567"
},
"Steps": [
{
"ID": 1,
"DeviceID": 2,
"DeviceName": "sample string 3",
"Description": "sample string 4",
"Editable": true,
"DelayFromStart": 6,
"TimeToRun": 7,
"TimeRemaining": 8,
"StartDate": "2025-11-09T21:36:43.9223311+10:00",
"FinishDate": "2025-11-09T21:36:43.9223311+10:00",
"CancelledDate": "2025-11-09T21:36:43.9223311+10:00",
"CancelledBy": 11,
"Progress": 12.1,
"SetValue": 13.1,
"ReturnValue": 14.1,
"Status": 1,
"ErrorStatus": 0,
"Message": "sample string 15",
"LinkedDeviceID": 16,
"LinkedDeviceName": "sample string 17",
"LinkCutoffValue": 18.1,
"BatchTotalised": true,
"MinutePrecision": true,
"Reading": {
"LastReading": "2025-11-09T21:36:43.9223311+10:00",
"Type": 0,
"Units": 0,
"Value": "sample string 2",
"Notes": "sample string 3",
"DelayFromStart": 4,
"TimeToRun": 5
},
"LinkedReading": {
"LastReading": "2025-11-09T21:36:43.9223311+10:00",
"Type": 0,
"Units": 0,
"Value": "sample string 2",
"Notes": "sample string 3"
}
},
{
"ID": 1,
"DeviceID": 2,
"DeviceName": "sample string 3",
"Description": "sample string 4",
"Editable": true,
"DelayFromStart": 6,
"TimeToRun": 7,
"TimeRemaining": 8,
"StartDate": "2025-11-09T21:36:43.9223311+10:00",
"FinishDate": "2025-11-09T21:36:43.9223311+10:00",
"CancelledDate": "2025-11-09T21:36:43.9223311+10:00",
"CancelledBy": 11,
"Progress": 12.1,
"SetValue": 13.1,
"ReturnValue": 14.1,
"Status": 1,
"ErrorStatus": 0,
"Message": "sample string 15",
"LinkedDeviceID": 16,
"LinkedDeviceName": "sample string 17",
"LinkCutoffValue": 18.1,
"BatchTotalised": true,
"MinutePrecision": true,
"Reading": {
"LastReading": "2025-11-09T21:36:43.9223311+10:00",
"Type": 0,
"Units": 0,
"Value": "sample string 2",
"Notes": "sample string 3",
"DelayFromStart": 4,
"TimeToRun": 5
},
"LinkedReading": {
"LastReading": "2025-11-09T21:36:43.9223311+10:00",
"Type": 0,
"Units": 0,
"Value": "sample string 2",
"Notes": "sample string 3"
}
}
]
},
{
"ID": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"StartDate": "2025-11-09T21:36:43.9223311+10:00",
"FinishDate": "2025-11-09T21:36:43.9223311+10:00",
"Progress": 6.1,
"ApprovedDate": "2025-11-09T21:36:43.9223311+10:00",
"ApprovedBy": 7,
"CancelledDate": "2025-11-09T21:36:43.9223311+10:00",
"CancelledBy": 8,
"Status": 1,
"Message": "sample string 9",
"Editable": true,
"Settings": {
"AutoCancel": true,
"HaltQueueOnError": true,
"CommandRetryLimit": 1,
"ResendOnError": true,
"ResendOnErrorLimit": 1,
"ResendOnErrorCount": 1,
"AllowStartDateAdjustment": true,
"SendPeriod": "00:00:00.1234567"
},
"Steps": [
{
"ID": 1,
"DeviceID": 2,
"DeviceName": "sample string 3",
"Description": "sample string 4",
"Editable": true,
"DelayFromStart": 6,
"TimeToRun": 7,
"TimeRemaining": 8,
"StartDate": "2025-11-09T21:36:43.9223311+10:00",
"FinishDate": "2025-11-09T21:36:43.9223311+10:00",
"CancelledDate": "2025-11-09T21:36:43.9223311+10:00",
"CancelledBy": 11,
"Progress": 12.1,
"SetValue": 13.1,
"ReturnValue": 14.1,
"Status": 1,
"ErrorStatus": 0,
"Message": "sample string 15",
"LinkedDeviceID": 16,
"LinkedDeviceName": "sample string 17",
"LinkCutoffValue": 18.1,
"BatchTotalised": true,
"MinutePrecision": true,
"Reading": {
"LastReading": "2025-11-09T21:36:43.9223311+10:00",
"Type": 0,
"Units": 0,
"Value": "sample string 2",
"Notes": "sample string 3",
"DelayFromStart": 4,
"TimeToRun": 5
},
"LinkedReading": {
"LastReading": "2025-11-09T21:36:43.9223311+10:00",
"Type": 0,
"Units": 0,
"Value": "sample string 2",
"Notes": "sample string 3"
}
},
{
"ID": 1,
"DeviceID": 2,
"DeviceName": "sample string 3",
"Description": "sample string 4",
"Editable": true,
"DelayFromStart": 6,
"TimeToRun": 7,
"TimeRemaining": 8,
"StartDate": "2025-11-09T21:36:43.9223311+10:00",
"FinishDate": "2025-11-09T21:36:43.9223311+10:00",
"CancelledDate": "2025-11-09T21:36:43.9223311+10:00",
"CancelledBy": 11,
"Progress": 12.1,
"SetValue": 13.1,
"ReturnValue": 14.1,
"Status": 1,
"ErrorStatus": 0,
"Message": "sample string 15",
"LinkedDeviceID": 16,
"LinkedDeviceName": "sample string 17",
"LinkCutoffValue": 18.1,
"BatchTotalised": true,
"MinutePrecision": true,
"Reading": {
"LastReading": "2025-11-09T21:36:43.9223311+10:00",
"Type": 0,
"Units": 0,
"Value": "sample string 2",
"Notes": "sample string 3",
"DelayFromStart": 4,
"TimeToRun": 5
},
"LinkedReading": {
"LastReading": "2025-11-09T21:36:43.9223311+10:00",
"Type": 0,
"Units": 0,
"Value": "sample string 2",
"Notes": "sample string 3"
}
}
]
}
],
"Messages": [
{
"Severity": 0,
"MessageCode": 1,
"CodeDesc": 2,
"MessageText": "sample string 3",
"RecordNumber": 4
},
{
"Severity": 0,
"MessageCode": 1,
"CodeDesc": 2,
"MessageText": "sample string 3",
"RecordNumber": 4
}
],
"ServerInformation": {
"CurrentTimeUTC": "2025-11-09T21:36:43.9223311+10:00",
"BuildDateUTC": "2025-11-09T21:36:43.9223311+10:00"
},
"VersionInformation": {
"Major": 1,
"Minor": 3,
"Hotfix": 7,
"Beta": false,
"Version": "1.3.7"
}
}
application/xml, text/xml
Sample:
<GetSchedulesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models.Responses">
<Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services">
<d2p1:Common.Message>
<d2p1:CodeDesc>2</d2p1:CodeDesc>
<d2p1:MessageCode>1</d2p1:MessageCode>
<d2p1:MessageText>sample string 3</d2p1:MessageText>
<d2p1:RecordNumber>4</d2p1:RecordNumber>
<d2p1:Severity>Information</d2p1:Severity>
</d2p1:Common.Message>
<d2p1:Common.Message>
<d2p1:CodeDesc>2</d2p1:CodeDesc>
<d2p1:MessageCode>1</d2p1:MessageCode>
<d2p1:MessageText>sample string 3</d2p1:MessageText>
<d2p1:RecordNumber>4</d2p1:RecordNumber>
<d2p1:Severity>Information</d2p1:Severity>
</d2p1:Common.Message>
</Messages>
<ServerInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata">
<d2p1:BuildDateUTC>2025-11-09T21:36:43.9223311+10:00</d2p1:BuildDateUTC>
<d2p1:CurrentTimeUTC>2025-11-09T21:36:43.9223311+10:00</d2p1:CurrentTimeUTC>
</ServerInformation>
<VersionInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata" />
<Schedules xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
<d2p1:APIStructs.Schedule>
<d2p1:ApprovedBy>7</d2p1:ApprovedBy>
<d2p1:ApprovedDate>2025-11-09T21:36:43.9223311+10:00</d2p1:ApprovedDate>
<d2p1:CancelledBy>8</d2p1:CancelledBy>
<d2p1:CancelledDate>2025-11-09T21:36:43.9223311+10:00</d2p1:CancelledDate>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:Editable>true</d2p1:Editable>
<d2p1:FinishDate>2025-11-09T21:36:43.9223311+10:00</d2p1:FinishDate>
<d2p1:ID>1</d2p1:ID>
<d2p1:Message>sample string 9</d2p1:Message>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:Progress>6.1</d2p1:Progress>
<d2p1:Settings>
<d2p1:AllowStartDateAdjustment>true</d2p1:AllowStartDateAdjustment>
<d2p1:AutoCancel>true</d2p1:AutoCancel>
<d2p1:CommandRetryLimit>1</d2p1:CommandRetryLimit>
<d2p1:HaltQueueOnError>true</d2p1:HaltQueueOnError>
<d2p1:ResendOnError>true</d2p1:ResendOnError>
<d2p1:ResendOnErrorCount>1</d2p1:ResendOnErrorCount>
<d2p1:ResendOnErrorLimit>1</d2p1:ResendOnErrorLimit>
<d2p1:SendPeriod>PT0.1234567S</d2p1:SendPeriod>
</d2p1:Settings>
<d2p1:StartDate>2025-11-09T21:36:43.9223311+10:00</d2p1:StartDate>
<d2p1:Status>Draft</d2p1:Status>
<d2p1:Steps>
<d2p1:APIStructs.Step>
<d2p1:BatchTotalised>true</d2p1:BatchTotalised>
<d2p1:CancelledBy>11</d2p1:CancelledBy>
<d2p1:CancelledDate>2025-11-09T21:36:43.9223311+10:00</d2p1:CancelledDate>
<d2p1:DelayFromStart>6</d2p1:DelayFromStart>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:DeviceID>2</d2p1:DeviceID>
<d2p1:DeviceName>sample string 3</d2p1:DeviceName>
<d2p1:Editable>true</d2p1:Editable>
<d2p1:ErrorStatus>None</d2p1:ErrorStatus>
<d2p1:FinishDate>2025-11-09T21:36:43.9223311+10:00</d2p1:FinishDate>
<d2p1:ID>1</d2p1:ID>
<d2p1:LinkCutoffValue>18.1</d2p1:LinkCutoffValue>
<d2p1:LinkedDeviceID>16</d2p1:LinkedDeviceID>
<d2p1:LinkedDeviceName>sample string 17</d2p1:LinkedDeviceName>
<d2p1:LinkedReading>
<d2p1:LastReading>2025-11-09T21:36:43.9223311+10:00</d2p1:LastReading>
<d2p1:Notes>sample string 3</d2p1:Notes>
<d2p1:Type>Generic</d2p1:Type>
<d2p1:Units>Status</d2p1:Units>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:LinkedReading>
<d2p1:Message>sample string 15</d2p1:Message>
<d2p1:MinutePrecision>true</d2p1:MinutePrecision>
<d2p1:Progress>12.1</d2p1:Progress>
<d2p1:Reading>
<d2p1:DelayFromStart>4</d2p1:DelayFromStart>
<d2p1:LastReading>2025-11-09T21:36:43.9223311+10:00</d2p1:LastReading>
<d2p1:Notes>sample string 3</d2p1:Notes>
<d2p1:TimeToRun>5</d2p1:TimeToRun>
<d2p1:Type>Generic</d2p1:Type>
<d2p1:Units>Status</d2p1:Units>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:Reading>
<d2p1:ReturnValue>14.1</d2p1:ReturnValue>
<d2p1:SetValue>13.1</d2p1:SetValue>
<d2p1:StartDate>2025-11-09T21:36:43.9223311+10:00</d2p1:StartDate>
<d2p1:Status>NotSent</d2p1:Status>
<d2p1:TimeRemaining>8</d2p1:TimeRemaining>
<d2p1:TimeToRun>7</d2p1:TimeToRun>
</d2p1:APIStructs.Step>
<d2p1:APIStructs.Step>
<d2p1:BatchTotalised>true</d2p1:BatchTotalised>
<d2p1:CancelledBy>11</d2p1:CancelledBy>
<d2p1:CancelledDate>2025-11-09T21:36:43.9223311+10:00</d2p1:CancelledDate>
<d2p1:DelayFromStart>6</d2p1:DelayFromStart>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:DeviceID>2</d2p1:DeviceID>
<d2p1:DeviceName>sample string 3</d2p1:DeviceName>
<d2p1:Editable>true</d2p1:Editable>
<d2p1:ErrorStatus>None</d2p1:ErrorStatus>
<d2p1:FinishDate>2025-11-09T21:36:43.9223311+10:00</d2p1:FinishDate>
<d2p1:ID>1</d2p1:ID>
<d2p1:LinkCutoffValue>18.1</d2p1:LinkCutoffValue>
<d2p1:LinkedDeviceID>16</d2p1:LinkedDeviceID>
<d2p1:LinkedDeviceName>sample string 17</d2p1:LinkedDeviceName>
<d2p1:LinkedReading>
<d2p1:LastReading>2025-11-09T21:36:43.9223311+10:00</d2p1:LastReading>
<d2p1:Notes>sample string 3</d2p1:Notes>
<d2p1:Type>Generic</d2p1:Type>
<d2p1:Units>Status</d2p1:Units>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:LinkedReading>
<d2p1:Message>sample string 15</d2p1:Message>
<d2p1:MinutePrecision>true</d2p1:MinutePrecision>
<d2p1:Progress>12.1</d2p1:Progress>
<d2p1:Reading>
<d2p1:DelayFromStart>4</d2p1:DelayFromStart>
<d2p1:LastReading>2025-11-09T21:36:43.9223311+10:00</d2p1:LastReading>
<d2p1:Notes>sample string 3</d2p1:Notes>
<d2p1:TimeToRun>5</d2p1:TimeToRun>
<d2p1:Type>Generic</d2p1:Type>
<d2p1:Units>Status</d2p1:Units>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:Reading>
<d2p1:ReturnValue>14.1</d2p1:ReturnValue>
<d2p1:SetValue>13.1</d2p1:SetValue>
<d2p1:StartDate>2025-11-09T21:36:43.9223311+10:00</d2p1:StartDate>
<d2p1:Status>NotSent</d2p1:Status>
<d2p1:TimeRemaining>8</d2p1:TimeRemaining>
<d2p1:TimeToRun>7</d2p1:TimeToRun>
</d2p1:APIStructs.Step>
</d2p1:Steps>
</d2p1:APIStructs.Schedule>
<d2p1:APIStructs.Schedule>
<d2p1:ApprovedBy>7</d2p1:ApprovedBy>
<d2p1:ApprovedDate>2025-11-09T21:36:43.9223311+10:00</d2p1:ApprovedDate>
<d2p1:CancelledBy>8</d2p1:CancelledBy>
<d2p1:CancelledDate>2025-11-09T21:36:43.9223311+10:00</d2p1:CancelledDate>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:Editable>true</d2p1:Editable>
<d2p1:FinishDate>2025-11-09T21:36:43.9223311+10:00</d2p1:FinishDate>
<d2p1:ID>1</d2p1:ID>
<d2p1:Message>sample string 9</d2p1:Message>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:Progress>6.1</d2p1:Progress>
<d2p1:Settings>
<d2p1:AllowStartDateAdjustment>true</d2p1:AllowStartDateAdjustment>
<d2p1:AutoCancel>true</d2p1:AutoCancel>
<d2p1:CommandRetryLimit>1</d2p1:CommandRetryLimit>
<d2p1:HaltQueueOnError>true</d2p1:HaltQueueOnError>
<d2p1:ResendOnError>true</d2p1:ResendOnError>
<d2p1:ResendOnErrorCount>1</d2p1:ResendOnErrorCount>
<d2p1:ResendOnErrorLimit>1</d2p1:ResendOnErrorLimit>
<d2p1:SendPeriod>PT0.1234567S</d2p1:SendPeriod>
</d2p1:Settings>
<d2p1:StartDate>2025-11-09T21:36:43.9223311+10:00</d2p1:StartDate>
<d2p1:Status>Draft</d2p1:Status>
<d2p1:Steps>
<d2p1:APIStructs.Step>
<d2p1:BatchTotalised>true</d2p1:BatchTotalised>
<d2p1:CancelledBy>11</d2p1:CancelledBy>
<d2p1:CancelledDate>2025-11-09T21:36:43.9223311+10:00</d2p1:CancelledDate>
<d2p1:DelayFromStart>6</d2p1:DelayFromStart>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:DeviceID>2</d2p1:DeviceID>
<d2p1:DeviceName>sample string 3</d2p1:DeviceName>
<d2p1:Editable>true</d2p1:Editable>
<d2p1:ErrorStatus>None</d2p1:ErrorStatus>
<d2p1:FinishDate>2025-11-09T21:36:43.9223311+10:00</d2p1:FinishDate>
<d2p1:ID>1</d2p1:ID>
<d2p1:LinkCutoffValue>18.1</d2p1:LinkCutoffValue>
<d2p1:LinkedDeviceID>16</d2p1:LinkedDeviceID>
<d2p1:LinkedDeviceName>sample string 17</d2p1:LinkedDeviceName>
<d2p1:LinkedReading>
<d2p1:LastReading>2025-11-09T21:36:43.9223311+10:00</d2p1:LastReading>
<d2p1:Notes>sample string 3</d2p1:Notes>
<d2p1:Type>Generic</d2p1:Type>
<d2p1:Units>Status</d2p1:Units>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:LinkedReading>
<d2p1:Message>sample string 15</d2p1:Message>
<d2p1:MinutePrecision>true</d2p1:MinutePrecision>
<d2p1:Progress>12.1</d2p1:Progress>
<d2p1:Reading>
<d2p1:DelayFromStart>4</d2p1:DelayFromStart>
<d2p1:LastReading>2025-11-09T21:36:43.9223311+10:00</d2p1:LastReading>
<d2p1:Notes>sample string 3</d2p1:Notes>
<d2p1:TimeToRun>5</d2p1:TimeToRun>
<d2p1:Type>Generic</d2p1:Type>
<d2p1:Units>Status</d2p1:Units>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:Reading>
<d2p1:ReturnValue>14.1</d2p1:ReturnValue>
<d2p1:SetValue>13.1</d2p1:SetValue>
<d2p1:StartDate>2025-11-09T21:36:43.9223311+10:00</d2p1:StartDate>
<d2p1:Status>NotSent</d2p1:Status>
<d2p1:TimeRemaining>8</d2p1:TimeRemaining>
<d2p1:TimeToRun>7</d2p1:TimeToRun>
</d2p1:APIStructs.Step>
<d2p1:APIStructs.Step>
<d2p1:BatchTotalised>true</d2p1:BatchTotalised>
<d2p1:CancelledBy>11</d2p1:CancelledBy>
<d2p1:CancelledDate>2025-11-09T21:36:43.9223311+10:00</d2p1:CancelledDate>
<d2p1:DelayFromStart>6</d2p1:DelayFromStart>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:DeviceID>2</d2p1:DeviceID>
<d2p1:DeviceName>sample string 3</d2p1:DeviceName>
<d2p1:Editable>true</d2p1:Editable>
<d2p1:ErrorStatus>None</d2p1:ErrorStatus>
<d2p1:FinishDate>2025-11-09T21:36:43.9223311+10:00</d2p1:FinishDate>
<d2p1:ID>1</d2p1:ID>
<d2p1:LinkCutoffValue>18.1</d2p1:LinkCutoffValue>
<d2p1:LinkedDeviceID>16</d2p1:LinkedDeviceID>
<d2p1:LinkedDeviceName>sample string 17</d2p1:LinkedDeviceName>
<d2p1:LinkedReading>
<d2p1:LastReading>2025-11-09T21:36:43.9223311+10:00</d2p1:LastReading>
<d2p1:Notes>sample string 3</d2p1:Notes>
<d2p1:Type>Generic</d2p1:Type>
<d2p1:Units>Status</d2p1:Units>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:LinkedReading>
<d2p1:Message>sample string 15</d2p1:Message>
<d2p1:MinutePrecision>true</d2p1:MinutePrecision>
<d2p1:Progress>12.1</d2p1:Progress>
<d2p1:Reading>
<d2p1:DelayFromStart>4</d2p1:DelayFromStart>
<d2p1:LastReading>2025-11-09T21:36:43.9223311+10:00</d2p1:LastReading>
<d2p1:Notes>sample string 3</d2p1:Notes>
<d2p1:TimeToRun>5</d2p1:TimeToRun>
<d2p1:Type>Generic</d2p1:Type>
<d2p1:Units>Status</d2p1:Units>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:Reading>
<d2p1:ReturnValue>14.1</d2p1:ReturnValue>
<d2p1:SetValue>13.1</d2p1:SetValue>
<d2p1:StartDate>2025-11-09T21:36:43.9223311+10:00</d2p1:StartDate>
<d2p1:Status>NotSent</d2p1:Status>
<d2p1:TimeRemaining>8</d2p1:TimeRemaining>
<d2p1:TimeToRun>7</d2p1:TimeToRun>
</d2p1:APIStructs.Step>
</d2p1:Steps>
</d2p1:APIStructs.Schedule>
</Schedules>
</GetSchedulesResponse>