POST 1.0/{InstanceId}/IntegrationLinks

Imports an Integration Link from an XML file - creates databases, products, document types, document tags, integration links and integration detail links as required

Request Information

URI Parameters

API Parameter Details
NameDescriptionTypeAdditional information
InstanceId

The instance ID relating to a specific ADM database

 string

Required

Body Parameters

Contains details of the integration links to be imported

ImportIntegrationLinkRequest
API Parameter Details
NameDescriptionTypeAdditional information
SqlDatabaseName

Integration Link SQL Database Name for the integration

 string

Required
XMLImport

Integration Link XML Import File containing the contents of the import xml file as a string

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "SqlDatabaseName": "sample string 1",
  "XMLImport": "sample string 2"
}

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 'ImportIntegrationLinkRequest'.

Response Information

Resource Description

Returns "OK" if the integration links were imported successfully, otherwise an appropriate error message

CreatedResourceResponse
API Parameter Details
NameDescriptionTypeAdditional information
Id

The id of the newly created resource

 integer

None.
Uri

The Uri location of the newly created resource

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Uri": "sample string 2"
}