GET api/{database}/DmDocumentList/{linkType}/{linkValue}?pattern={pattern}

Gets a list of DmDocument that matches the specified criteria



Request Information

Parameters

NameDescriptionAdditional information
linkType The linkType.

Define this parameter in the request URI.

linkValue The linkValue.

Define this parameter in the request URI.

pattern The pattern.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "messages": [],
    "canChange": true,
    "cannotChangeReason": "sample string 2",
    "createdBy": "sample string 3",
    "dateCreated": "sample string 4",
    "dateSent": "sample string 5",
    "description": "sample string 6",
    "documentLink": "sample string 7",
    "documentType": "sample string 8",
    "linkCategoryName": "sample string 9",
    "linkId": "sample string 10",
    "linkType": "sample string 11",
    "reference": "sample string 12",
    "sentTo": "sample string 13",
    "subject": "sample string 14"
  },
  {
    "messages": [],
    "canChange": true,
    "cannotChangeReason": "sample string 2",
    "createdBy": "sample string 3",
    "dateCreated": "sample string 4",
    "dateSent": "sample string 5",
    "description": "sample string 6",
    "documentLink": "sample string 7",
    "documentType": "sample string 8",
    "linkCategoryName": "sample string 9",
    "linkId": "sample string 10",
    "linkType": "sample string 11",
    "reference": "sample string 12",
    "sentTo": "sample string 13",
    "subject": "sample string 14"
  },
  {
    "messages": [],
    "canChange": true,
    "cannotChangeReason": "sample string 2",
    "createdBy": "sample string 3",
    "dateCreated": "sample string 4",
    "dateSent": "sample string 5",
    "description": "sample string 6",
    "documentLink": "sample string 7",
    "documentType": "sample string 8",
    "linkCategoryName": "sample string 9",
    "linkId": "sample string 10",
    "linkType": "sample string 11",
    "reference": "sample string 12",
    "sentTo": "sample string 13",
    "subject": "sample string 14"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDmDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.DocMan.Edit">
  <DmDocument>
    <CanChange>true</CanChange>
    <CannotChangeReason>sample string 2</CannotChangeReason>
    <CreatedBy>sample string 3</CreatedBy>
    <DateCreated>sample string 4</DateCreated>
    <DateSent>sample string 5</DateSent>
    <Description>sample string 6</Description>
    <DocumentLink>sample string 7</DocumentLink>
    <DocumentType>sample string 8</DocumentType>
    <LinkCategoryName>sample string 9</LinkCategoryName>
    <LinkId>sample string 10</LinkId>
    <LinkType>sample string 11</LinkType>
    <Messages xmlns:d3p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.Web.WebApi.Core.Models" />
    <Reference>sample string 12</Reference>
    <SentTo>sample string 13</SentTo>
    <Subject>sample string 14</Subject>
  </DmDocument>
  <DmDocument>
    <CanChange>true</CanChange>
    <CannotChangeReason>sample string 2</CannotChangeReason>
    <CreatedBy>sample string 3</CreatedBy>
    <DateCreated>sample string 4</DateCreated>
    <DateSent>sample string 5</DateSent>
    <Description>sample string 6</Description>
    <DocumentLink>sample string 7</DocumentLink>
    <DocumentType>sample string 8</DocumentType>
    <LinkCategoryName>sample string 9</LinkCategoryName>
    <LinkId>sample string 10</LinkId>
    <LinkType>sample string 11</LinkType>
    <Messages xmlns:d3p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.Web.WebApi.Core.Models" />
    <Reference>sample string 12</Reference>
    <SentTo>sample string 13</SentTo>
    <Subject>sample string 14</Subject>
  </DmDocument>
  <DmDocument>
    <CanChange>true</CanChange>
    <CannotChangeReason>sample string 2</CannotChangeReason>
    <CreatedBy>sample string 3</CreatedBy>
    <DateCreated>sample string 4</DateCreated>
    <DateSent>sample string 5</DateSent>
    <Description>sample string 6</Description>
    <DocumentLink>sample string 7</DocumentLink>
    <DocumentType>sample string 8</DocumentType>
    <LinkCategoryName>sample string 9</LinkCategoryName>
    <LinkId>sample string 10</LinkId>
    <LinkType>sample string 11</LinkType>
    <Messages xmlns:d3p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.Web.WebApi.Core.Models" />
    <Reference>sample string 12</Reference>
    <SentTo>sample string 13</SentTo>
    <Subject>sample string 14</Subject>
  </DmDocument>
</ArrayOfDmDocument>