Last modified by jklein on 2025/06/16 08:23

From version 2.1
edited by jklein
on 2025/06/16 07:55
Change comment: There is no comment for this version
To version 7.1
edited by jklein
on 2025/06/16 08:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Verwenden der ACMP Public API
1 +Verwenden der ACMP Public API für PowerShell-Microservices
Content
... ... @@ -1,3 +1,5 @@
1 +{{aagon.floatingbox/}}
2 +
1 1  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.
2 2  
3 3  = Aufbau von Cmdlets der ACMP Public API =
... ... @@ -13,11 +13,10 @@
13 13  
14 14  Welcher Datentyp in welchem Cmdlet verwendet werden muss, können Sie sich über die Hilfe des jeweiligen Cmdlets anzeigen lassen.
15 15  
16 -=== Beispiel 1 ===
18 +=== Beispiel 1: Get-Help ===
17 17  
18 -{{code language="PowerShell" layout="LINENUMBERS" title="
19 -
20 - "}}
20 +{{apimacro title="Get-Help"}}
21 +{{code language="PowerShell"}}
21 21  PS C:\Program Files (x86)\Aagon\AESB Shell> Get-Help Acmp-SaveContacts_V3
22 22  
23 23  NAME
... ... @@ -34,12 +34,14 @@
34 34  REMARKS
35 35   None
36 36  {{/code}}
38 +{{/apimacro}}
37 37  
38 38  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.
39 39  
40 -=== Beispiel 2 ===
42 +=== Beispiel 2: Speichern von Kontakten ===
41 41  
42 -{{code language="PowerShell" layout="LINENUMBERS" title="**Beispiel: Speichern von Kontakten**"}}
44 +{{apimacro title="Speichern von Kontakten"}}
45 +{{code language="PowerShell" layout="LINENUMBERS"}}
43 43  
44 44  # Erstellen einer Liste
45 45  $contacts = @()
... ... @@ -65,7 +65,14 @@
65 65  ------------- ---------- -------------
66 66   0 OK
67 67  {{/code}}
71 +{{/apimacro}}
68 68  
69 69  Anhand der Antwort der Public API ist eine Fehlerbehandlung möglich.
70 70  
75 += Verwenden von Cmdlets der ACMP Public API im Skript Editor =
76 +
77 +Zum Verwenden von Cmdlets der ACMP Public API im Script Editor, müssen Sie das entsprechende [[Modul zur PowerShell-Vorlage hinzufügen>>doc:AESB.111.Workspaces.Powershell.Module.WebHome]]. 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//).
78 +
79 +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>>doc:ACMP.68.Datenaustausch mit ACMP über die Public API.WebHome]].
80 +
71 71  
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community