POST api/SatelliteServices/SyncSatelliteServiceToSSE/{satelliteUniqueId}

Request Information

URI Parameters

Name	Description	Type	Additional information
satelliteUniqueId		globally unique identifier	Required

Body Parameters

Satellite

Name	Type	Additional information
SatelliteId	integer	None.
IPAddress	string	None.
SatelliteUniqueId	globally unique identifier	None.
IsOnline	boolean	None.
SatellitePlugins	Collection of SatellitePlugin	None.
Starship	Starship	None.

Request Formats

application/json, text/json

Sample:

{
  "SatelliteId": 1,
  "IPAddress": "sample string 2",
  "SatelliteUniqueId": "2eace17e-6a9f-4953-8bdd-81f11724603c",
  "IsOnline": true,
  "SatellitePlugins": [
    {
      "SatellitePluginId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Plugin": {
        "PluginID": 1,
        "PluginName": "sample string 2",
        "IsExecutableInd": true
      },
      "CyclePattern": {
        "CyclePatternID": 1,
        "CycleNextRunDate": "2026-01-12T22:51:43.2101443+00:00",
        "CycleStartDate": "2026-01-12T22:51:43.2101443+00:00",
        "WeekdayID": 4,
        "RecurrenceInterval": 5,
        "RecurrencePattern": {
          "Id": 1,
          "AltName": "sample string 2",
          "Key": "sample string 3",
          "Name": "sample string 4"
        }
      },
      "SatellitePluginQueries": [
        {
          "SatellitePluginQueryID": 1,
          "SatellitePluginID": 2,
          "SqlBaseQuery": "sample string 3",
          "QueryTypeID": 4,
          "SatellitePluginQueryParameters": [
            {
              "SatellitePluginQueryParameterID": 1,
              "SatellitePluginQueryID": 2,
              "ParameterName": "sample string 3",
              "Comparator": "sample string 4",
              "ParameterValue": "sample string 5",
              "ParameterDataType": "sample string 6"
            },
            {
              "SatellitePluginQueryParameterID": 1,
              "SatellitePluginQueryID": 2,
              "ParameterName": "sample string 3",
              "Comparator": "sample string 4",
              "ParameterValue": "sample string 5",
              "ParameterDataType": "sample string 6"
            }
          ]
        },
        {
          "SatellitePluginQueryID": 1,
          "SatellitePluginID": 2,
          "SqlBaseQuery": "sample string 3",
          "QueryTypeID": 4,
          "SatellitePluginQueryParameters": [
            {
              "SatellitePluginQueryParameterID": 1,
              "SatellitePluginQueryID": 2,
              "ParameterName": "sample string 3",
              "Comparator": "sample string 4",
              "ParameterValue": "sample string 5",
              "ParameterDataType": "sample string 6"
            },
            {
              "SatellitePluginQueryParameterID": 1,
              "SatellitePluginQueryID": 2,
              "ParameterName": "sample string 3",
              "Comparator": "sample string 4",
              "ParameterValue": "sample string 5",
              "ParameterDataType": "sample string 6"
            }
          ]
        }
      ],
      "SatellitePluginSettings": [
        {
          "Id": 1,
          "SavedSettingValue": "sample string 2",
          "Setting": {
            "SettingId": 1,
            "Name": "sample string 2",
            "Key": "sample string 3",
            "Default": "sample string 4"
          }
        },
        {
          "Id": 1,
          "SavedSettingValue": "sample string 2",
          "Setting": {
            "SettingId": 1,
            "Name": "sample string 2",
            "Key": "sample string 3",
            "Default": "sample string 4"
          }
        }
      ]
    },
    {
      "SatellitePluginId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Plugin": {
        "PluginID": 1,
        "PluginName": "sample string 2",
        "IsExecutableInd": true
      },
      "CyclePattern": {
        "CyclePatternID": 1,
        "CycleNextRunDate": "2026-01-12T22:51:43.2101443+00:00",
        "CycleStartDate": "2026-01-12T22:51:43.2101443+00:00",
        "WeekdayID": 4,
        "RecurrenceInterval": 5,
        "RecurrencePattern": {
          "Id": 1,
          "AltName": "sample string 2",
          "Key": "sample string 3",
          "Name": "sample string 4"
        }
      },
      "SatellitePluginQueries": [
        {
          "SatellitePluginQueryID": 1,
          "SatellitePluginID": 2,
          "SqlBaseQuery": "sample string 3",
          "QueryTypeID": 4,
          "SatellitePluginQueryParameters": [
            {
              "SatellitePluginQueryParameterID": 1,
              "SatellitePluginQueryID": 2,
              "ParameterName": "sample string 3",
              "Comparator": "sample string 4",
              "ParameterValue": "sample string 5",
              "ParameterDataType": "sample string 6"
            },
            {
              "SatellitePluginQueryParameterID": 1,
              "SatellitePluginQueryID": 2,
              "ParameterName": "sample string 3",
              "Comparator": "sample string 4",
              "ParameterValue": "sample string 5",
              "ParameterDataType": "sample string 6"
            }
          ]
        },
        {
          "SatellitePluginQueryID": 1,
          "SatellitePluginID": 2,
          "SqlBaseQuery": "sample string 3",
          "QueryTypeID": 4,
          "SatellitePluginQueryParameters": [
            {
              "SatellitePluginQueryParameterID": 1,
              "SatellitePluginQueryID": 2,
              "ParameterName": "sample string 3",
              "Comparator": "sample string 4",
              "ParameterValue": "sample string 5",
              "ParameterDataType": "sample string 6"
            },
            {
              "SatellitePluginQueryParameterID": 1,
              "SatellitePluginQueryID": 2,
              "ParameterName": "sample string 3",
              "Comparator": "sample string 4",
              "ParameterValue": "sample string 5",
              "ParameterDataType": "sample string 6"
            }
          ]
        }
      ],
      "SatellitePluginSettings": [
        {
          "Id": 1,
          "SavedSettingValue": "sample string 2",
          "Setting": {
            "SettingId": 1,
            "Name": "sample string 2",
            "Key": "sample string 3",
            "Default": "sample string 4"
          }
        },
        {
          "Id": 1,
          "SavedSettingValue": "sample string 2",
          "Setting": {
            "SettingId": 1,
            "Name": "sample string 2",
            "Key": "sample string 3",
            "Default": "sample string 4"
          }
        }
      ]
    }
  ],
  "Starship": {
    "StarshipId": 1,
    "URL": "sample string 2",
    "Name": "sample string 3",
    "SSEConnectorDLL": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<Satellite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DOStarship.WebApi.Models">
  <IPAddress>sample string 2</IPAddress>
  <IsOnline>true</IsOnline>
  <SatelliteId>1</SatelliteId>
  <SatellitePlugins>
    <SatellitePlugin>
      <CyclePattern>
        <CycleNextRunDate>2026-01-12T22:51:43.2101443+00:00</CycleNextRunDate>
        <CyclePatternID>1</CyclePatternID>
        <CycleStartDate>2026-01-12T22:51:43.2101443+00:00</CycleStartDate>
        <RecurrenceInterval>5</RecurrenceInterval>
        <RecurrencePattern>
          <AltName>sample string 2</AltName>
          <Id>1</Id>
          <Key>sample string 3</Key>
          <Name>sample string 4</Name>
        </RecurrencePattern>
        <WeekdayID>4</WeekdayID>
      </CyclePattern>
      <Description>sample string 3</Description>
      <Name>sample string 2</Name>
      <Plugin>
        <IsExecutableInd>true</IsExecutableInd>
        <PluginID>1</PluginID>
        <PluginName>sample string 2</PluginName>
      </Plugin>
      <SatellitePluginId>1</SatellitePluginId>
      <SatellitePluginQueries>
        <SatellitePluginQuery>
          <QueryTypeID>4</QueryTypeID>
          <SatellitePluginID>2</SatellitePluginID>
          <SatellitePluginQueryID>1</SatellitePluginQueryID>
          <SatellitePluginQueryParameters>
            <SatellitePluginQueryParameter>
              <Comparator>sample string 4</Comparator>
              <ParameterDataType>sample string 6</ParameterDataType>
              <ParameterName>sample string 3</ParameterName>
              <ParameterValue>sample string 5</ParameterValue>
              <SatellitePluginQueryID>2</SatellitePluginQueryID>
              <SatellitePluginQueryParameterID>1</SatellitePluginQueryParameterID>
            </SatellitePluginQueryParameter>
            <SatellitePluginQueryParameter>
              <Comparator>sample string 4</Comparator>
              <ParameterDataType>sample string 6</ParameterDataType>
              <ParameterName>sample string 3</ParameterName>
              <ParameterValue>sample string 5</ParameterValue>
              <SatellitePluginQueryID>2</SatellitePluginQueryID>
              <SatellitePluginQueryParameterID>1</SatellitePluginQueryParameterID>
            </SatellitePluginQueryParameter>
          </SatellitePluginQueryParameters>
          <SqlBaseQuery>sample string 3</SqlBaseQuery>
        </SatellitePluginQuery>
        <SatellitePluginQuery>
          <QueryTypeID>4</QueryTypeID>
          <SatellitePluginID>2</SatellitePluginID>
          <SatellitePluginQueryID>1</SatellitePluginQueryID>
          <SatellitePluginQueryParameters>
            <SatellitePluginQueryParameter>
              <Comparator>sample string 4</Comparator>
              <ParameterDataType>sample string 6</ParameterDataType>
              <ParameterName>sample string 3</ParameterName>
              <ParameterValue>sample string 5</ParameterValue>
              <SatellitePluginQueryID>2</SatellitePluginQueryID>
              <SatellitePluginQueryParameterID>1</SatellitePluginQueryParameterID>
            </SatellitePluginQueryParameter>
            <SatellitePluginQueryParameter>
              <Comparator>sample string 4</Comparator>
              <ParameterDataType>sample string 6</ParameterDataType>
              <ParameterName>sample string 3</ParameterName>
              <ParameterValue>sample string 5</ParameterValue>
              <SatellitePluginQueryID>2</SatellitePluginQueryID>
              <SatellitePluginQueryParameterID>1</SatellitePluginQueryParameterID>
            </SatellitePluginQueryParameter>
          </SatellitePluginQueryParameters>
          <SqlBaseQuery>sample string 3</SqlBaseQuery>
        </SatellitePluginQuery>
      </SatellitePluginQueries>
      <SatellitePluginSettings>
        <SatellitePluginSetting>
          <Id>1</Id>
          <SavedSettingValue>sample string 2</SavedSettingValue>
          <Setting>
            <Default>sample string 4</Default>
            <Key>sample string 3</Key>
            <Name>sample string 2</Name>
            <SettingId>1</SettingId>
          </Setting>
        </SatellitePluginSetting>
        <SatellitePluginSetting>
          <Id>1</Id>
          <SavedSettingValue>sample string 2</SavedSettingValue>
          <Setting>
            <Default>sample string 4</Default>
            <Key>sample string 3</Key>
            <Name>sample string 2</Name>
            <SettingId>1</SettingId>
          </Setting>
        </SatellitePluginSetting>
      </SatellitePluginSettings>
    </SatellitePlugin>
    <SatellitePlugin>
      <CyclePattern>
        <CycleNextRunDate>2026-01-12T22:51:43.2101443+00:00</CycleNextRunDate>
        <CyclePatternID>1</CyclePatternID>
        <CycleStartDate>2026-01-12T22:51:43.2101443+00:00</CycleStartDate>
        <RecurrenceInterval>5</RecurrenceInterval>
        <RecurrencePattern>
          <AltName>sample string 2</AltName>
          <Id>1</Id>
          <Key>sample string 3</Key>
          <Name>sample string 4</Name>
        </RecurrencePattern>
        <WeekdayID>4</WeekdayID>
      </CyclePattern>
      <Description>sample string 3</Description>
      <Name>sample string 2</Name>
      <Plugin>
        <IsExecutableInd>true</IsExecutableInd>
        <PluginID>1</PluginID>
        <PluginName>sample string 2</PluginName>
      </Plugin>
      <SatellitePluginId>1</SatellitePluginId>
      <SatellitePluginQueries>
        <SatellitePluginQuery>
          <QueryTypeID>4</QueryTypeID>
          <SatellitePluginID>2</SatellitePluginID>
          <SatellitePluginQueryID>1</SatellitePluginQueryID>
          <SatellitePluginQueryParameters>
            <SatellitePluginQueryParameter>
              <Comparator>sample string 4</Comparator>
              <ParameterDataType>sample string 6</ParameterDataType>
              <ParameterName>sample string 3</ParameterName>
              <ParameterValue>sample string 5</ParameterValue>
              <SatellitePluginQueryID>2</SatellitePluginQueryID>
              <SatellitePluginQueryParameterID>1</SatellitePluginQueryParameterID>
            </SatellitePluginQueryParameter>
            <SatellitePluginQueryParameter>
              <Comparator>sample string 4</Comparator>
              <ParameterDataType>sample string 6</ParameterDataType>
              <ParameterName>sample string 3</ParameterName>
              <ParameterValue>sample string 5</ParameterValue>
              <SatellitePluginQueryID>2</SatellitePluginQueryID>
              <SatellitePluginQueryParameterID>1</SatellitePluginQueryParameterID>
            </SatellitePluginQueryParameter>
          </SatellitePluginQueryParameters>
          <SqlBaseQuery>sample string 3</SqlBaseQuery>
        </SatellitePluginQuery>
        <SatellitePluginQuery>
          <QueryTypeID>4</QueryTypeID>
          <SatellitePluginID>2</SatellitePluginID>
          <SatellitePluginQueryID>1</SatellitePluginQueryID>
          <SatellitePluginQueryParameters>
            <SatellitePluginQueryParameter>
              <Comparator>sample string 4</Comparator>
              <ParameterDataType>sample string 6</ParameterDataType>
              <ParameterName>sample string 3</ParameterName>
              <ParameterValue>sample string 5</ParameterValue>
              <SatellitePluginQueryID>2</SatellitePluginQueryID>
              <SatellitePluginQueryParameterID>1</SatellitePluginQueryParameterID>
            </SatellitePluginQueryParameter>
            <SatellitePluginQueryParameter>
              <Comparator>sample string 4</Comparator>
              <ParameterDataType>sample string 6</ParameterDataType>
              <ParameterName>sample string 3</ParameterName>
              <ParameterValue>sample string 5</ParameterValue>
              <SatellitePluginQueryID>2</SatellitePluginQueryID>
              <SatellitePluginQueryParameterID>1</SatellitePluginQueryParameterID>
            </SatellitePluginQueryParameter>
          </SatellitePluginQueryParameters>
          <SqlBaseQuery>sample string 3</SqlBaseQuery>
        </SatellitePluginQuery>
      </SatellitePluginQueries>
      <SatellitePluginSettings>
        <SatellitePluginSetting>
          <Id>1</Id>
          <SavedSettingValue>sample string 2</SavedSettingValue>
          <Setting>
            <Default>sample string 4</Default>
            <Key>sample string 3</Key>
            <Name>sample string 2</Name>
            <SettingId>1</SettingId>
          </Setting>
        </SatellitePluginSetting>
        <SatellitePluginSetting>
          <Id>1</Id>
          <SavedSettingValue>sample string 2</SavedSettingValue>
          <Setting>
            <Default>sample string 4</Default>
            <Key>sample string 3</Key>
            <Name>sample string 2</Name>
            <SettingId>1</SettingId>
          </Setting>
        </SatellitePluginSetting>
      </SatellitePluginSettings>
    </SatellitePlugin>
  </SatellitePlugins>
  <SatelliteUniqueId>2eace17e-6a9f-4953-8bdd-81f11724603c</SatelliteUniqueId>
  <Starship>
    <Name>sample string 3</Name>
    <SSEConnectorDLL>sample string 4</SSEConnectorDLL>
    <StarshipId>1</StarshipId>
    <URL>sample string 2</URL>
  </Starship>
</Satellite>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.