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

Updates an DetailLink for the given Integration Link and DetailLinkId

Request Information

URI Parameters

API Parameter Details
NameDescriptionTypeAdditional 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

Contains details of the integration link detail to be updated

CreateUpdateIntegrationLinkDetailRequest
API Parameter Details
NameDescriptionTypeAdditional information
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.

Request Formats

application/json, text/json

Sample:
{
  "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": []
  }
}

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

Response Information

Resource Description

Appropriate HTTP headers with no content are returned only