GET v1/integration/{integrationName}/getSettings

Request Information

URI Parameters

NameDescriptionTypeAdditional information
integrationName

string

Required

Body Parameters

None.

Response Information

Resource Description

IntegrationSettingsModel
NameDescriptionTypeAdditional information
IntegrationID

integer

None.

UserName

string

None.

Password

string

None.

Protocol

string

None.

Port

string

None.

HostName

string

None.

DestinationFolder

string

None.

FileName

string

None.

ArchiveFolder

string

None.

FileFormat

string

None.

FileSeparator

string

None.

DownloadFile

boolean

None.

ProcessFile

boolean

None.

TranslateFile

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "integrationID": 1,
  "userName": "sample string 2",
  "password": "sample string 3",
  "protocol": "sample string 4",
  "port": "sample string 5",
  "hostName": "sample string 6",
  "destinationFolder": "sample string 7",
  "fileName": "sample string 8",
  "archiveFolder": "sample string 9",
  "fileFormat": "sample string 10",
  "fileSeparator": "sample string 11",
  "downloadFile": true,
  "processFile": true,
  "translateFile": true
}