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

From version 1.1
edited by jklein
on 2025/06/16 07:54
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,40 +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 -{{apimacro}}{{/apimacro}}
19 -
20 -(% class="showhide-header" data-show-duration="$effectduration" data-show-effect="$effect" %)
21 -(((
22 -(% class="showhide-header-flex" %)
23 -(((
24 -(% class="showhide-title" %)
25 -(((
26 -**Beispiel: Get-Help**
27 -)))
28 -
29 -(% class="showhide-title" %)
30 -(((
31 -
32 -)))
33 -
34 -(% class="showhide-arrow" %)
35 -(((
36 -▶
37 -)))
38 -)))
39 -)))
40 -
41 -(% class="showhidecontent" style="display: none;" %)
42 -(((
43 -
44 -)))
45 -
46 -{{code language="PowerShell" layout="LINENUMBERS" title="
47 -
48 -
49 - "}}
20 +{{apimacro title="Get-Help"}}
21 +{{code language="PowerShell"}}
50 50  PS C:\Program Files (x86)\Aagon\AESB Shell> Get-Help Acmp-SaveContacts_V3
51 51  
52 52  NAME
... ... @@ -63,12 +63,14 @@
63 63  REMARKS
64 64   None
65 65  {{/code}}
38 +{{/apimacro}}
66 66  
67 67  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.
68 68  
69 -=== Beispiel 2 ===
42 +=== Beispiel 2: Speichern von Kontakten ===
70 70  
71 -{{code language="PowerShell" layout="LINENUMBERS" title="**Beispiel: Speichern von Kontakten**"}}
44 +{{apimacro title="Speichern von Kontakten"}}
45 +{{code language="PowerShell" layout="LINENUMBERS"}}
72 72  
73 73  # Erstellen einer Liste
74 74  $contacts = @()
... ... @@ -94,7 +94,14 @@
94 94  ------------- ---------- -------------
95 95   0 OK
96 96  {{/code}}
71 +{{/apimacro}}
97 97  
98 98  Anhand der Antwort der Public API ist eine Fehlerbehandlung möglich.
99 99  
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 +
100 100  
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community