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

From version 3.1
edited by jklein
on 2025/06/16 07:56
Change comment: There is no comment for this version
To version 6.1
edited by jklein
on 2025/06/16 08:13
Change comment: There is no comment for this version

Summary

Details

Page properties
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 =
... ... @@ -16,14 +16,31 @@
16 16  === Beispiel 1: Get-Help ===
17 17  
18 18  {{apimacro title="Get-Help"}}
21 +{{code language="PowerShell"}}
22 +PS C:\Program Files (x86)\Aagon\AESB Shell> Get-Help Acmp-SaveContacts_V3
19 19  
24 +NAME
25 + Acmp-SaveContacts_V3
26 +
27 +SYNTAX
28 + Acmp-SaveContacts_V3 [[-ConnectionName] <string>] [-Contacts <List[TContact_V3]>] [-AcmpServerId <string>] [-Timeout <int>] [<CommonParameters>]
29 +
30 +
31 +ALIASES
32 + None
33 +
34 +
35 +REMARKS
36 + None
37 +{{/code}}
20 20  {{/apimacro}}
21 21  
22 22  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.
23 23  
24 -=== Beispiel 2 ===
42 +=== Beispiel 2: Speichern von Kontakten ===
25 25  
26 -{{code language="PowerShell" layout="LINENUMBERS" title="**Beispiel: Speichern von Kontakten**"}}
44 +{{apimacro title="Speichern von Kontakten"}}
45 +{{code language="PowerShell" layout="LINENUMBERS"}}
27 27  
28 28  # Erstellen einer Liste
29 29  $contacts = @()
... ... @@ -49,7 +49,14 @@
49 49  ------------- ---------- -------------
50 50   0 OK
51 51  {{/code}}
71 +{{/apimacro}}
52 52  
53 53  Anhand der Antwort der Public API ist eine Fehlerbehandlung möglich.
54 54  
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 +
55 55  
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community