GET api/SatellitePluginQueues?verbose={verbose}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| verbose | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of SatellitePluginQueue| Name | Description | Type | Additional information |
|---|---|---|---|
| SatellitePluginQueueId | integer |
None. |
|
| SatellitePluginId | integer |
None. |
|
| SatellitePlugin | SatellitePlugin |
None. |
|
| SatellitePluginQueueStatusId | integer |
None. |
|
| SatellitePluginQueueStatus | SatellitePluginQueueStatus |
None. |
|
| StartDateTime | date |
None. |
|
| EndDateTime | date |
None. |
|
| ActionDateTime | date |
None. |
|
| ExtractionQuery | string |
None. |
|
| RetryCount | integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"SatellitePluginQueueId": 1,
"SatellitePluginId": 1,
"SatellitePlugin": {
"SatellitePluginId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"PluginId": 4,
"Plugin": {
"PluginId": 1,
"Name": "sample string 2",
"ShortName": "sample string 3",
"Path": "sample string 4",
"IsLatestVersion": true,
"AllowAutoUpdate": true,
"IsExecutable": true,
"PluginSettings": [
{
"PluginSettingId": 1,
"PluginId": 2,
"SettingId": 3,
"IsRequired": true,
"Setting": {
"SettingId": 1,
"Name": "sample string 2",
"Key": "sample string 3",
"Default": "sample string 4",
"IsAdvanced": true
}
},
{
"PluginSettingId": 1,
"PluginId": 2,
"SettingId": 3,
"IsRequired": true,
"Setting": {
"SettingId": 1,
"Name": "sample string 2",
"Key": "sample string 3",
"Default": "sample string 4",
"IsAdvanced": true
}
}
]
},
"CyclePatternId": 1,
"CyclePattern": {
"CyclePatternId": 1,
"StartDate": "2026-03-05T02:41:07.954194+00:00",
"Recurrence": 3,
"NextRunDate": "2026-03-05T02:41:07.954194+00:00",
"SingleRunDate": "2026-03-05T02:41:07.954194+00:00",
"RecurrencePatternId": 5,
"RecurrencePattern": {
"RecurrencePatternId": 1,
"Name": "sample string 2",
"Alias": "sample string 3",
"Key": "sample string 4"
},
"WeekdayId": 6,
"Weekday": {
"WeekdayId": 1,
"Name": "sample string 2",
"Key": "sample string 3",
"Number": 4
},
"DayOfMonth": 7
},
"SatelliteId": 5,
"Satellite": {
"SatelliteId": 1,
"ClientId": 1,
"URL": "sample string 2",
"Name": "sample string 3",
"IPAddress": "sample string 4",
"Protocol": "sample string 5",
"PortNumber": "sample string 6",
"ServiceContract": "sample string 7",
"StarshipId": 8,
"UniqueId": "144f1149-cb49-4b44-8c68-61a9315207db",
"SerialNumber": "sample string 10",
"MacAddress": "sample string 11",
"WindowsKey": "sample string 12",
"Active": true,
"Latitude": 14.0,
"Longitude": 15.0,
"IsOnline": true
}
},
"SatellitePluginQueueStatusId": 1,
"SatellitePluginQueueStatus": {
"SatellitePluginQueueStatusId": 1,
"Name": "sample string 2",
"Key": "sample string 3",
"Run": true
},
"StartDateTime": "2026-03-05T02:41:07.954194+00:00",
"EndDateTime": "2026-03-05T02:41:07.954194+00:00",
"ActionDateTime": "2026-03-05T02:41:07.954194+00:00",
"ExtractionQuery": "sample string 2",
"RetryCount": 3
},
{
"SatellitePluginQueueId": 1,
"SatellitePluginId": 1,
"SatellitePlugin": {
"SatellitePluginId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"PluginId": 4,
"Plugin": {
"PluginId": 1,
"Name": "sample string 2",
"ShortName": "sample string 3",
"Path": "sample string 4",
"IsLatestVersion": true,
"AllowAutoUpdate": true,
"IsExecutable": true,
"PluginSettings": [
{
"PluginSettingId": 1,
"PluginId": 2,
"SettingId": 3,
"IsRequired": true,
"Setting": {
"SettingId": 1,
"Name": "sample string 2",
"Key": "sample string 3",
"Default": "sample string 4",
"IsAdvanced": true
}
},
{
"PluginSettingId": 1,
"PluginId": 2,
"SettingId": 3,
"IsRequired": true,
"Setting": {
"SettingId": 1,
"Name": "sample string 2",
"Key": "sample string 3",
"Default": "sample string 4",
"IsAdvanced": true
}
}
]
},
"CyclePatternId": 1,
"CyclePattern": {
"CyclePatternId": 1,
"StartDate": "2026-03-05T02:41:07.954194+00:00",
"Recurrence": 3,
"NextRunDate": "2026-03-05T02:41:07.954194+00:00",
"SingleRunDate": "2026-03-05T02:41:07.954194+00:00",
"RecurrencePatternId": 5,
"RecurrencePattern": {
"RecurrencePatternId": 1,
"Name": "sample string 2",
"Alias": "sample string 3",
"Key": "sample string 4"
},
"WeekdayId": 6,
"Weekday": {
"WeekdayId": 1,
"Name": "sample string 2",
"Key": "sample string 3",
"Number": 4
},
"DayOfMonth": 7
},
"SatelliteId": 5,
"Satellite": {
"SatelliteId": 1,
"ClientId": 1,
"URL": "sample string 2",
"Name": "sample string 3",
"IPAddress": "sample string 4",
"Protocol": "sample string 5",
"PortNumber": "sample string 6",
"ServiceContract": "sample string 7",
"StarshipId": 8,
"UniqueId": "144f1149-cb49-4b44-8c68-61a9315207db",
"SerialNumber": "sample string 10",
"MacAddress": "sample string 11",
"WindowsKey": "sample string 12",
"Active": true,
"Latitude": 14.0,
"Longitude": 15.0,
"IsOnline": true
}
},
"SatellitePluginQueueStatusId": 1,
"SatellitePluginQueueStatus": {
"SatellitePluginQueueStatusId": 1,
"Name": "sample string 2",
"Key": "sample string 3",
"Run": true
},
"StartDateTime": "2026-03-05T02:41:07.954194+00:00",
"EndDateTime": "2026-03-05T02:41:07.954194+00:00",
"ActionDateTime": "2026-03-05T02:41:07.954194+00:00",
"ExtractionQuery": "sample string 2",
"RetryCount": 3
}
]
application/xml, text/xml
Sample:
<ArrayOfSatellitePluginQueue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Starship.WebAPI.Models">
<SatellitePluginQueue>
<ActionDateTime>2026-03-05T02:41:07.954194+00:00</ActionDateTime>
<EndDateTime>2026-03-05T02:41:07.954194+00:00</EndDateTime>
<ExtractionQuery>sample string 2</ExtractionQuery>
<RetryCount>3</RetryCount>
<SatellitePlugin>
<CyclePattern>
<CyclePatternId>1</CyclePatternId>
<DayOfMonth>7</DayOfMonth>
<NextRunDate>2026-03-05T02:41:07.954194+00:00</NextRunDate>
<Recurrence>3</Recurrence>
<RecurrencePattern>
<Alias>sample string 3</Alias>
<Key>sample string 4</Key>
<Name>sample string 2</Name>
<RecurrencePatternId>1</RecurrencePatternId>
</RecurrencePattern>
<RecurrencePatternId>5</RecurrencePatternId>
<SingleRunDate>2026-03-05T02:41:07.954194+00:00</SingleRunDate>
<StartDate>2026-03-05T02:41:07.954194+00:00</StartDate>
<Weekday>
<Key>sample string 3</Key>
<Name>sample string 2</Name>
<Number>4</Number>
<WeekdayId>1</WeekdayId>
</Weekday>
<WeekdayId>6</WeekdayId>
</CyclePattern>
<CyclePatternId>1</CyclePatternId>
<Description>sample string 3</Description>
<Name>sample string 2</Name>
<Plugin>
<AllowAutoUpdate>true</AllowAutoUpdate>
<IsExecutable>true</IsExecutable>
<IsLatestVersion>true</IsLatestVersion>
<Name>sample string 2</Name>
<Path>sample string 4</Path>
<PluginId>1</PluginId>
<PluginSettings>
<PluginSetting>
<IsRequired>true</IsRequired>
<PluginId>2</PluginId>
<PluginSettingId>1</PluginSettingId>
<Setting>
<Default>sample string 4</Default>
<IsAdvanced>true</IsAdvanced>
<Key>sample string 3</Key>
<Name>sample string 2</Name>
<SettingId>1</SettingId>
</Setting>
<SettingId>3</SettingId>
</PluginSetting>
<PluginSetting>
<IsRequired>true</IsRequired>
<PluginId>2</PluginId>
<PluginSettingId>1</PluginSettingId>
<Setting>
<Default>sample string 4</Default>
<IsAdvanced>true</IsAdvanced>
<Key>sample string 3</Key>
<Name>sample string 2</Name>
<SettingId>1</SettingId>
</Setting>
<SettingId>3</SettingId>
</PluginSetting>
</PluginSettings>
<ShortName>sample string 3</ShortName>
</Plugin>
<PluginId>4</PluginId>
<Satellite>
<Active>true</Active>
<ClientId>1</ClientId>
<IPAddress>sample string 4</IPAddress>
<IsOnline>true</IsOnline>
<Latitude>14</Latitude>
<Longitude>15</Longitude>
<MacAddress>sample string 11</MacAddress>
<Name>sample string 3</Name>
<PortNumber>sample string 6</PortNumber>
<Protocol>sample string 5</Protocol>
<SatelliteId>1</SatelliteId>
<SerialNumber>sample string 10</SerialNumber>
<ServiceContract>sample string 7</ServiceContract>
<StarshipId>8</StarshipId>
<URL>sample string 2</URL>
<UniqueId>144f1149-cb49-4b44-8c68-61a9315207db</UniqueId>
<WindowsKey>sample string 12</WindowsKey>
</Satellite>
<SatelliteId>5</SatelliteId>
<SatellitePluginId>1</SatellitePluginId>
</SatellitePlugin>
<SatellitePluginId>1</SatellitePluginId>
<SatellitePluginQueueId>1</SatellitePluginQueueId>
<SatellitePluginQueueStatus>
<Key>sample string 3</Key>
<Name>sample string 2</Name>
<Run>true</Run>
<SatellitePluginQueueStatusId>1</SatellitePluginQueueStatusId>
</SatellitePluginQueueStatus>
<SatellitePluginQueueStatusId>1</SatellitePluginQueueStatusId>
<StartDateTime>2026-03-05T02:41:07.954194+00:00</StartDateTime>
</SatellitePluginQueue>
<SatellitePluginQueue>
<ActionDateTime>2026-03-05T02:41:07.954194+00:00</ActionDateTime>
<EndDateTime>2026-03-05T02:41:07.954194+00:00</EndDateTime>
<ExtractionQuery>sample string 2</ExtractionQuery>
<RetryCount>3</RetryCount>
<SatellitePlugin>
<CyclePattern>
<CyclePatternId>1</CyclePatternId>
<DayOfMonth>7</DayOfMonth>
<NextRunDate>2026-03-05T02:41:07.954194+00:00</NextRunDate>
<Recurrence>3</Recurrence>
<RecurrencePattern>
<Alias>sample string 3</Alias>
<Key>sample string 4</Key>
<Name>sample string 2</Name>
<RecurrencePatternId>1</RecurrencePatternId>
</RecurrencePattern>
<RecurrencePatternId>5</RecurrencePatternId>
<SingleRunDate>2026-03-05T02:41:07.954194+00:00</SingleRunDate>
<StartDate>2026-03-05T02:41:07.954194+00:00</StartDate>
<Weekday>
<Key>sample string 3</Key>
<Name>sample string 2</Name>
<Number>4</Number>
<WeekdayId>1</WeekdayId>
</Weekday>
<WeekdayId>6</WeekdayId>
</CyclePattern>
<CyclePatternId>1</CyclePatternId>
<Description>sample string 3</Description>
<Name>sample string 2</Name>
<Plugin>
<AllowAutoUpdate>true</AllowAutoUpdate>
<IsExecutable>true</IsExecutable>
<IsLatestVersion>true</IsLatestVersion>
<Name>sample string 2</Name>
<Path>sample string 4</Path>
<PluginId>1</PluginId>
<PluginSettings>
<PluginSetting>
<IsRequired>true</IsRequired>
<PluginId>2</PluginId>
<PluginSettingId>1</PluginSettingId>
<Setting>
<Default>sample string 4</Default>
<IsAdvanced>true</IsAdvanced>
<Key>sample string 3</Key>
<Name>sample string 2</Name>
<SettingId>1</SettingId>
</Setting>
<SettingId>3</SettingId>
</PluginSetting>
<PluginSetting>
<IsRequired>true</IsRequired>
<PluginId>2</PluginId>
<PluginSettingId>1</PluginSettingId>
<Setting>
<Default>sample string 4</Default>
<IsAdvanced>true</IsAdvanced>
<Key>sample string 3</Key>
<Name>sample string 2</Name>
<SettingId>1</SettingId>
</Setting>
<SettingId>3</SettingId>
</PluginSetting>
</PluginSettings>
<ShortName>sample string 3</ShortName>
</Plugin>
<PluginId>4</PluginId>
<Satellite>
<Active>true</Active>
<ClientId>1</ClientId>
<IPAddress>sample string 4</IPAddress>
<IsOnline>true</IsOnline>
<Latitude>14</Latitude>
<Longitude>15</Longitude>
<MacAddress>sample string 11</MacAddress>
<Name>sample string 3</Name>
<PortNumber>sample string 6</PortNumber>
<Protocol>sample string 5</Protocol>
<SatelliteId>1</SatelliteId>
<SerialNumber>sample string 10</SerialNumber>
<ServiceContract>sample string 7</ServiceContract>
<StarshipId>8</StarshipId>
<URL>sample string 2</URL>
<UniqueId>144f1149-cb49-4b44-8c68-61a9315207db</UniqueId>
<WindowsKey>sample string 12</WindowsKey>
</Satellite>
<SatelliteId>5</SatelliteId>
<SatellitePluginId>1</SatellitePluginId>
</SatellitePlugin>
<SatellitePluginId>1</SatellitePluginId>
<SatellitePluginQueueId>1</SatellitePluginQueueId>
<SatellitePluginQueueStatus>
<Key>sample string 3</Key>
<Name>sample string 2</Name>
<Run>true</Run>
<SatellitePluginQueueStatusId>1</SatellitePluginQueueStatusId>
</SatellitePluginQueueStatus>
<SatellitePluginQueueStatusId>1</SatellitePluginQueueStatusId>
<StartDateTime>2026-03-05T02:41:07.954194+00:00</StartDateTime>
</SatellitePluginQueue>
</ArrayOfSatellitePluginQueue>