DocumentTypes

GET 1.0/{InstanceId}/DocumentTypes

Retrieves an unordered list of all document types

Request Information

URI Parameters

API Parameter Details
Name	Description	Type	Additional information
InstanceId	The instance ID relating to a specific ADM database	string	Required

Body Parameters

None.

Response Information

Resource Description

A list of DocumentType objects

Collection of DocumentType

API Parameter Details
Name	Description	Type	Additional information
Id	The ID of the Document Type	integer	None.
Url	A URL which can be used to retrieve details on the Document Type related to this result	string	None.
Name	The name of the document type corresponding to the DocTypeId	string	None.
Description	The description of the Document Type	string	None.
Tags	Document tags and related properties associated with this document	Collection of TagAssociation	None.
Active	Set to False when this document type is disabled	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Url": "sample string 2",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "Tags": [
      {
        "Tag": {
          "Id": 1,
          "Url": "sample string 2",
          "Name": "sample string 3",
          "Description": "sample string 4",
          "DataType": "String",
          "FieldLength": 5
        },
        "ReadOnly": true,
        "DisplayOrder": 2,
        "SimpleSearchEnabled": true,
        "CreateIndex": true,
        "ValueListItems": "sample string 5"
      },
      {
        "Tag": {
          "Id": 1,
          "Url": "sample string 2",
          "Name": "sample string 3",
          "Description": "sample string 4",
          "DataType": "String",
          "FieldLength": 5
        },
        "ReadOnly": true,
        "DisplayOrder": 2,
        "SimpleSearchEnabled": true,
        "CreateIndex": true,
        "ValueListItems": "sample string 5"
      }
    ],
    "Active": true
  },
  {
    "Id": 1,
    "Url": "sample string 2",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "Tags": [
      {
        "Tag": {
          "Id": 1,
          "Url": "sample string 2",
          "Name": "sample string 3",
          "Description": "sample string 4",
          "DataType": "String",
          "FieldLength": 5
        },
        "ReadOnly": true,
        "DisplayOrder": 2,
        "SimpleSearchEnabled": true,
        "CreateIndex": true,
        "ValueListItems": "sample string 5"
      },
      {
        "Tag": {
          "Id": 1,
          "Url": "sample string 2",
          "Name": "sample string 3",
          "Description": "sample string 4",
          "DataType": "String",
          "FieldLength": 5
        },
        "ReadOnly": true,
        "DisplayOrder": 2,
        "SimpleSearchEnabled": true,
        "CreateIndex": true,
        "ValueListItems": "sample string 5"
      }
    ],
    "Active": true
  }
]