POST v1/SyncSystemRequests

Creates a sync system request.

Request Information

Requires Authorization!

URI Parameters

None.

Body Parameters

The parameters to create a sync system request with.

SyncSystemRequestPostParameters
NameDescriptionTypeAdditional information
ConsumerLevelId

The consumer level

 integer

None.
ConsumerLevelEntityId

The consumer level entity id

 integer

None.
AppModuleDefinitionId

The app module definition id

 integer

None.
FeatureId

The feature id

 integer

None.
Parameters

The SyncSystemRequest's parameters

 Collection of RequestParam

None.

Request Formats

application/json, text/json

Sample: 
{
  "ConsumerLevelId": 1,
  "ConsumerLevelEntityId": 1,
  "AppModuleDefinitionId": 2,
  "FeatureId": 3,
  "Parameters": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<SyncSystemRequestPostParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ConsumerLevelId>1</ConsumerLevelId>
  <ConsumerLevelEntityId>1</ConsumerLevelEntityId>
  <AppModuleDefinitionId>2</AppModuleDefinitionId>
  <FeatureId>3</FeatureId>
  <Parameters>
    <RequestParam>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </RequestParam>
    <RequestParam>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </RequestParam>
  </Parameters>
</SyncSystemRequestPostParameters>

Response Information

Resource Description

The SyncSystemRequestBasicInfo object


Collection of SyncSystemRequestBasicInfo
NameDescriptionTypeAdditional information
Id

Gets or sets the identifier.

 integer

Must be 0
CreateTimestamp

Gets or sets the create timestamp.

 date

Required
StartTimestamp

Gets or sets the start timestamp.

 date

None.
FinishedTimestamp

Gets or sets the finished timestamp.

 date

None.
StatusName

Gets or sets the status.

 string

None.
AppModuleName

Gets or sets the app module name.

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "CreateTimestamp": "2021-12-02T20:19:39.5447429+01:00",
    "StartTimestamp": "2021-12-02T20:19:39.5447429+01:00",
    "FinishedTimestamp": "2021-12-02T20:19:39.5447429+01:00",
    "StatusName": "sample string 3",
    "AppModuleName": "sample string 4"
  },
  {
    "Id": 1,
    "CreateTimestamp": "2021-12-02T20:19:39.5447429+01:00",
    "StartTimestamp": "2021-12-02T20:19:39.5447429+01:00",
    "FinishedTimestamp": "2021-12-02T20:19:39.5447429+01:00",
    "StatusName": "sample string 3",
    "AppModuleName": "sample string 4"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfSyncSystemRequestBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SyncSystemRequestBasicInfo>
    <Id>1</Id>
    <CreateTimestamp>2021-12-02T20:19:39.5447429+01:00</CreateTimestamp>
    <StartTimestamp>2021-12-02T20:19:39.5447429+01:00</StartTimestamp>
    <FinishedTimestamp>2021-12-02T20:19:39.5447429+01:00</FinishedTimestamp>
    <StatusName>sample string 3</StatusName>
    <AppModuleName>sample string 4</AppModuleName>
  </SyncSystemRequestBasicInfo>
  <SyncSystemRequestBasicInfo>
    <Id>1</Id>
    <CreateTimestamp>2021-12-02T20:19:39.5447429+01:00</CreateTimestamp>
    <StartTimestamp>2021-12-02T20:19:39.5447429+01:00</StartTimestamp>
    <FinishedTimestamp>2021-12-02T20:19:39.5447429+01:00</FinishedTimestamp>
    <StatusName>sample string 3</StatusName>
    <AppModuleName>sample string 4</AppModuleName>
  </SyncSystemRequestBasicInfo>
</ArrayOfSyncSystemRequestBasicInfo>