POST api/v1/integrations/imports/start

Start integration import

Request Information

URI Parameters

None.

Body Parameters

request

StartIntegrationImportV1Request
NameDescriptionTypeAdditional information
IntegrationId

Integration id

universally unique identifier

Required

Example value: 8fa615d4-6de7-427e-9d65-cbdefb4a3e1f

FileVersionId

File version id

universally unique identifier

Required

Example value: 9aa13ef5-8547-4c75-bad0-b9af033ee552

FileName

File name

string

Required

Example value: example.xlsx

FileSize

File size

integer (64 bits)

Required

Example value: 5000

FileDate

File date

date

Required

Example value: 05/01/2008 08:06:32 +01:00

Request Formats

application/json

Sample:
{
  "IntegrationId": "8fa615d4-6de7-427e-9d65-cbdefb4a3e1f",
  "FileVersionId": "9aa13ef5-8547-4c75-bad0-b9af033ee552",
  "FileName": "example.xlsx",
  "FileSize": 5000,
  "FileDate": "2008-05-01T07:06:32+00:00"
}

Response Information

Resource Description

Start integration import

StartIntegrationImportV1Response
NameDescriptionTypeAdditional information
IntegrationImportId

Integration import id

universally unique identifier

Required

Example value: 02ead820-839d-42ff-ae00-e1436802a92e

Response Formats

application/json

Sample:
{
  "IntegrationImportId": "02ead820-839d-42ff-ae00-e1436802a92e"
}