Mit den Cmdlets der ACMP Public API haben Sie Zugriff auf zentrale Funktionalitäten von ACMP, z.B. Geräteinformationen, Ticketmanagement, Benutzerverwaltung oder Ereignisprotokolle. Diese Cmdlets können Sie in Ihren Skripten für PowerShell-Microservices verwenden und damit weitere Funktionalitäten automatisieren.

Aufbau von Cmdlets der ACMP Public API

Bei den Cmdlets der ACMP Public API wird zwischen dem eigentlichen Public API Command und den zugehörigen Datentypen unterschieden. Hierbei fangen alle Cmdlets mit dem Verb Acmp an und alle Datentypen mit dem Verb New.

Welcher Datentyp in welchem Cmdlet verwendet werden muss, können Sie sich über die Hilfe des jeweiligen Cmdlets anzeigen lassen.

Beispiel 1: Get-Help

An diesem Output ist ersichtlich, dass das Cmdlet eine Liste von TContact_V3 erwartet. Es müssen also Kontakte mithilfe von New-TContact_V3 erstellt und befüllt werden.

Beispiel 2: Speichern von Kontakten

Anhand der Antwort der Public API ist eine Fehlerbehandlung möglich.

Verwenden von Cmdlets der ACMP Public API im Skript Editor

Zum Verwenden von Cmdlets der ACMP Public API im Script Editor, müssen Sie das entsprechende Modul zur PowerShell-Vorlage hinzufügen. Falls Sie beim Hinzufügen des Public API-Moduls ein Präfix vergeben haben, wird dies zusätzlich im Namen der Cmdlets verwendet. (wenn Sie z.B. das Präfix PublicAPI vergeben haben, hat das Cmdlet den Namen Acmp-PublicAPISaveContacts_V3).

Die ausführliche Dokumentation aller ACMP Public API Commands finden Sie in der ACMP Online Hilfe im Abschnitt Datenaustausch mit ACMP über die Public API.