Retrieve the categories of a destination system

Method and endpoint	`GET /Categories`

The method and endpoint GET /Categories returns the document categories of a destination system. Categories are used to classify documents thematically and as templates for new documents in the destination systems. In addition to the ID and the name, the properties of a category are also transmitted. If the category is used as a template to create a document, the properties of the template become the properties of the new document.

Things to know

Some destination systems support so-called subcategories. You can recognize subcategories by the pipe character in the ID and Name fields. The ID and name of the category and the ID and name of the subcategory are separated by the pipe character.

In the Microsoft SharePoint context, "subcategory" refers to the content type.

Example of a request

GET /Categories
Accept: application/json
ModuleId: sharepoint
ConnectionString: targetHost=https://test.sharepoint.com;User=MyUserName;Password=MyPassword;ListId=MyListId;

Example of a response

JSON

[
  {
    "properties": [
      {
        "id": "Title",
        "name": "Title",
        "type": "Text",
        "isRequired": false,
        "alias": "Title"
      },
      {
        "id": "TenantId",
        "name": "TenantId",
        "type": "Text",
        "isRequired": false,
        "alias": "TenantId"
      },
      {
        "id": "Tenant_x0020_Name",
        "name": "Tenant Name",
        "type": "Text",
        "isRequired": false,
        "alias": "Tenant_x0020_Name"
      },
      {
        "id": "Vendor_x002d_No_x002e_",
        "name": "Vendor No.",
        "type": "Text",
        "isRequired": false,
        "alias": "Vendor_x002d_No_x002e_"
      },
      {
        "id": "Vendor_x002d_Name",
        "name": "Vendor Name",
        "type": "Text",
        "isRequired": false,
        "alias": "Vendor_x002d_Name"
      }
    ],
    "id": "dc4af18a-dd54-4735-bad5-92517e8653f2",
    "name": "Document"
  },
  {
    "properties": [
      {
        "id": "Title",
        "name": "Title",
        "type": "Text",
        "isRequired": false,
        "alias": "Title"
      },
      {
        "id": "TenantId",
        "name": "TenantId",
        "type": "Text",
        "isRequired": false,
        "alias": "TenantId"
      },
      {
        "id": "Tenant_x0020_Name",
        "name": "Tenant Name",
        "type": "Text",
        "isRequired": false,
        "alias": "Tenant_x0020_Name"
      },
      {
        "id": "Vendor_x002d_No_x002e_",
        "name": "Vendor No.",
        "type": "Text",
        "isRequired": false,
        "alias": "Vendor_x002d_No_x002e_"
      },
      {
        "id": "Vendor_x002d_Name",
        "name": "Vendor Name",
        "type": "Text",
        "isRequired": false,
        "alias": "Vendor_x002d_Name"
      },
      {
        "id": "Invoice_x002d_No_x002e_",
        "name": "Invoice No.",
        "type": "Text",
        "isRequired": false,
        "alias": "Invoice_x002d_No_x002e_"
      },
	  {
        "id": "Invoicedate",
        "name": "Invoicedate",
        "type": "DateTime",
        "isRequired": false,
        "alias": "Invoicedate"
      }
    ],
    "id": "dc4af18a-dd54-4735-bad5-92517e8653f2|0x010100B1436945C37C404992A0C63B488FD4E3010011D354D3F2D224468B038FB961F78D01",
    "name": "Document|Invoice"
  }
]