IntegrationLinks

GET 1.0/{InstanceId}/IntegrationLinks/{IntegrationLinkId}/DetailLinks/{DetailLinkId}

Retrieves an DetailLink for the given Integration Link and DetailLinkId

Request Information

URI Parameters

API Parameter Details
Name	Description	Type	Additional information
InstanceId	The instance ID relating to a specific ADM database	string	Required
IntegrationLinkId	The IntegrationLinkId ID relating to the DetailLinkId you want to return the detail link for	integer	Required
DetailLinkId	The DetailLinkId ID relating to a specific DetailLinkId you want to return the detail link for	integer	Required

Body Parameters

None.

Response Information

Resource Description

A DetailLink object

IntegrationDetailLink

API Parameter Details
Name	Description	Type	Additional information
Id	The ID of this Integration Detail Link	integer	None.
HeaderId	The Header ID of this Integration Detail Link	integer	None.
LinkTypeId	The Link Type Id of this Integration Detail Link	integer	None.
LinkTypeName	The Link Type Name	string	None.
Search	The Detail Link's Filing Search Settings	IntegrationLinkDetailSearch	None.
FileAwayDefaults	The Detail Link's Filing Defaults Settings	IntegrationDetailLinkFilingDefaults	None.
CustomSearchCriteria	Filter Tree Expression	FilterTree	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "HeaderId": 2,
  "LinkTypeId": 3,
  "LinkTypeName": "sample string 4",
  "Search": {
    "BaseFolderId": 1,
    "IncludeSubFolders": true,
    "DocumentTypeIds": [
      1,
      2
    ],
    "FilterSettings": {
      "Primary": {
        "Enabled": true,
        "TagId": 2
      },
      "DBName": {
        "Enabled": true,
        "TagId": 2
      }
    }
  },
  "FileAwayDefaults": {
    "Enabled": true,
    "FolderId": 2,
    "DefaultDocumentTypeId": 3,
    "DocumentTypeIds": [
      1,
      2
    ]
  },
  "CustomSearchCriteria": {
    "LogicOperator": "And",
    "Conditions": [
      {
        "Column": "DocId",
        "TagId": 1,
        "Operator": "Begins",
        "Value": {},
        "Value2": {}
      },
      {
        "Column": "DocId",
        "TagId": 1,
        "Operator": "Begins",
        "Value": {},
        "Value2": {}
      }
    ],
    "ChildFilterTrees": []
  }
}