POST api/OmsManageConfigurations/tasks

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
ConfigurationUIGroupID	integer	None.
ConfigurationUIGroupName	string	Required
SiteID	integer	Range: inclusive between 1 and 2147483647
SortOrder	integer	None.
Url	string	Required
Headers	string	Required
NotificationVersion	integer	Required
EndpointUserName	string	Required
EndpointPassword	string	Required
IsDeleted	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ConfigurationUIGroupID": 1,
  "ConfigurationUIGroupName": "sample string 1",
  "SiteID": 2,
  "SortOrder": 3,
  "Url": "sample string 4",
  "Headers": "sample string 5",
  "NotificationVersion": 6,
  "EndpointUserName": "sample string 7",
  "EndpointPassword": "sample string 8",
  "IsDeleted": true
}

application/xml, text/xml

Sample:

<TaskManagerModelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <ConfigurationUIGroupID>1</ConfigurationUIGroupID>
  <ConfigurationUIGroupName>sample string 1</ConfigurationUIGroupName>
  <EndpointPassword>sample string 8</EndpointPassword>
  <EndpointUserName>sample string 7</EndpointUserName>
  <Headers>sample string 5</Headers>
  <IsDeleted>true</IsDeleted>
  <NotificationVersion>6</NotificationVersion>
  <SiteID>2</SiteID>
  <SortOrder>3</SortOrder>
  <Url>sample string 4</Url>
</TaskManagerModelRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TaskManagerModelResponse

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

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Model": {
    "TaskPlugin": null,
    "Sites": null,
    "ConfigurationUIGroups": null,
    "SelectedSite": 1,
    "ErrorMessage": "sample string 2",
    "SuccessMessage": "sample string 3",
    "VerificationErrors": [
      "sample string 1",
      "sample string 2"
    ],
    "SiteID": 4,
    "ConfigurationUIGroupID": 5,
    "ConfigurationUIGroupName": "sample string 6",
    "ConfigurationUIID": 7,
    "SortOrder": 8,
    "URL": "sample string 9",
    "UserName": "sample string 10",
    "Password": "sample string 11",
    "Headers": "sample string 12",
    "Refresh": true,
    "Delete": true,
    "PluginTypeID": 15,
    "IsSuperUser": true,
    "NotificationVersion": 17,
    "PasswordRandom": "sample string 18",
    "TempUN": "sample string 19"
  }
}

application/xml, text/xml

Sample:

<TaskManagerModelResponse 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:ConfigurationUIGroupID>5</d2p1:ConfigurationUIGroupID>
    <d2p1:ConfigurationUIGroupName>sample string 6</d2p1:ConfigurationUIGroupName>
    <d2p1:ConfigurationUIGroups xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:ConfigurationUIID>7</d2p1:ConfigurationUIID>
    <d2p1:Delete>true</d2p1:Delete>
    <d2p1:ErrorMessage>sample string 2</d2p1:ErrorMessage>
    <d2p1:Headers>sample string 12</d2p1:Headers>
    <d2p1:IsSuperUser>true</d2p1:IsSuperUser>
    <d2p1:NotificationVersion>17</d2p1:NotificationVersion>
    <d2p1:Password>sample string 11</d2p1:Password>
    <d2p1:PasswordRandom>sample string 18</d2p1:PasswordRandom>
    <d2p1:PluginTypeID>15</d2p1:PluginTypeID>
    <d2p1:Refresh>true</d2p1:Refresh>
    <d2p1:SelectedSite>1</d2p1:SelectedSite>
    <d2p1:SiteID>4</d2p1:SiteID>
    <d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:SortOrder>8</d2p1:SortOrder>
    <d2p1:SuccessMessage>sample string 3</d2p1:SuccessMessage>
    <d2p1:TaskPlugin i:nil="true" />
    <d2p1:TempUN>sample string 19</d2p1:TempUN>
    <d2p1:URL>sample string 9</d2p1:URL>
    <d2p1:UserName>sample string 10</d2p1:UserName>
    <d2p1:VerificationErrors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:VerificationErrors>
  </Model>
  <ResponseCode>Success</ResponseCode>
</TaskManagerModelResponse>