Abrufen der Kategorien eines Zielsystems

Methode und Endpunkt	`GET /Categories`

Die Methode und der Endpunkt GET /Categories gibt Ihnen die Dokumentenkategorien eines Zielsystems zurück. Kategorien dienen zum thematischen Einordnen von Dokumenten und als Vorlagen für neue Dokumente in den Zielsystemen. Neben der ID und dem Namen werden auch die Eigenschaften einer Kategorie übermittelt. Wenn die Kategorie als Vorlage zum Erstellen eines Dokuments verwendet wird, werden die Eigenschaften der Vorlage zu Eigenschaften des neuen Dokuments.

Gut zu wissen

Manche Zielsysteme unterstützen sogenannte Unterkategorien. Sie erkennen Unterkategorien am Pipe-Zeichen in den Feldern ID und Name. Die ID und der Name der Kategorie sowie die ID und der Name der Unterkategorie werden mit dem Pipe-Zeichen getrennt dargestellt.

Im Microsoft SharePoint-Kontext bezeichnet “Unterkategorie” den Inhaltstyp (Content Type).

Beispiel für einen Request

CODE

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

Beispiel für einen 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"
  }
]