POST api/ProcessFileRequest

Request Information

URI Parameters

None.

Body Parameters

FileUtilityRequest
NameDescriptionTypeAdditional information
FileRequestId

string

None.

TemplateName

string

None.

doNotConvertoCSV

boolean

None.

loginDetail

clsLoginDetail

None.

sftpDetail

clsSFTPDetail

None.

Request Formats

application/json, text/json

Sample:
{
  "FileRequestId": "sample string 1",
  "TemplateName": "sample string 2",
  "doNotConvertoCSV": true,
  "loginDetail": {
    "sessionID": "sample string 1",
    "serverURL": "sample string 2",
    "orgID": "sample string 3",
    "userName": "sample string 4",
    "password": "sample string 5",
    "securityToken": "sample string 6",
    "connectionString": "sample string 7",
    "MetadataServerURL": "sample string 8"
  },
  "sftpDetail": {
    "hostName": "sample string 1",
    "userName": "sample string 2",
    "password": "sample string 3",
    "portNumber": 4,
    "folderPath": "sample string 5"
  }
}

application/xml, text/xml

Sample:
<FileUtilityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLR_ComEd_FileUtility.Models">
  <FileRequestId>sample string 1</FileRequestId>
  <TemplateName>sample string 2</TemplateName>
  <doNotConvertoCSV>true</doNotConvertoCSV>
  <loginDetail>
    <MetadataServerURL>sample string 8</MetadataServerURL>
    <connectionString>sample string 7</connectionString>
    <orgID>sample string 3</orgID>
    <password>sample string 5</password>
    <securityToken>sample string 6</securityToken>
    <serverURL>sample string 2</serverURL>
    <sessionID>sample string 1</sessionID>
    <userName>sample string 4</userName>
  </loginDetail>
  <sftpDetail>
    <folderPath>sample string 5</folderPath>
    <hostName>sample string 1</hostName>
    <password>sample string 3</password>
    <portNumber>4</portNumber>
    <userName>sample string 2</userName>
  </sftpDetail>
</FileUtilityRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FileUtilityResult
NameDescriptionTypeAdditional information
error

string

None.

success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "error": "sample string 1",
  "success": true
}

application/xml, text/xml

Sample:
<FileUtilityResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLR_ComEd_FileUtility.Models">
  <error>sample string 1</error>
  <success>true</success>
</FileUtilityResult>