PUT api/ExecuteCommand

Request Information

URI Parameters

None.

Body Parameters

ExecuteCommandRequest
NameDescriptionTypeAdditional information
CommandRequest

string

None.

CommandsRequestList

Collection of Object

None.

SecurityToken

globally unique identifier

None.

CustomerId

globally unique identifier

None.

UniqueIdDispositivo

globally unique identifier

None.

Ambiente

string

None.

DataBaseLogicalName

string

None.

ApiAppName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CommandRequest": "sample string 1",
  "CommandsRequestList": [
    {},
    {}
  ],
  "SecurityToken": "cd6c20ce-4cd3-4271-821f-cbe352f6aa8b",
  "CustomerId": "1a0d78cf-998f-4607-9baf-8e8f66320092",
  "UniqueIdDispositivo": "2f249582-6c34-4d15-b7f7-0bc4239efdff",
  "Ambiente": "sample string 4",
  "DataBaseLogicalName": "sample string 5",
  "ApiAppName": "sample string 6"
}

application/xml, text/xml

Sample:
<ExecuteCommandRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XmaintServices.Models">
  <Ambiente>sample string 4</Ambiente>
  <ApiAppName>sample string 6</ApiAppName>
  <CustomerId>1a0d78cf-998f-4607-9baf-8e8f66320092</CustomerId>
  <DataBaseLogicalName>sample string 5</DataBaseLogicalName>
  <SecurityToken>cd6c20ce-4cd3-4271-821f-cbe352f6aa8b</SecurityToken>
  <UniqueIdDispositivo>2f249582-6c34-4d15-b7f7-0bc4239efdff</UniqueIdDispositivo>
  <CommandRequest>sample string 1</CommandRequest>
  <CommandsRequestList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </CommandsRequestList>
</ExecuteCommandRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ExecuteCommandRequest'.

Response Information

Resource Description

ExecuteCommandResult
NameDescriptionTypeAdditional information
CommandRequest

string

None.

SecurityToken

globally unique identifier

None.

CustomerId

globally unique identifier

None.

ErrorMessage

string

None.

AuthorizationErrorMessage

string

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "CommandRequest": "sample string 1",
  "SecurityToken": "50ad0518-9829-4349-bd83-e69e5f340c30",
  "CustomerId": "ad4a3486-66ce-4ded-b36d-678f6bcbacc0",
  "ErrorMessage": "sample string 4",
  "AuthorizationErrorMessage": "sample string 5",
  "Success": true
}

application/xml, text/xml

Sample:
<ExecuteCommandResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XmaintServices.Models">
  <AuthorizationErrorMessage>sample string 5</AuthorizationErrorMessage>
  <CustomerId>ad4a3486-66ce-4ded-b36d-678f6bcbacc0</CustomerId>
  <ErrorMessage>sample string 4</ErrorMessage>
  <SecurityToken>50ad0518-9829-4349-bd83-e69e5f340c30</SecurityToken>
  <Success>true</Success>
  <CommandRequest>sample string 1</CommandRequest>
</ExecuteCommandResult>