Wiki source code of Verwenden der ACMP Public API
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 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 | |||
| 3 | = Aufbau von Cmdlets der ACMP Public API = | ||
| 4 | |||
| 5 | 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//. | ||
| 6 | |||
| 7 | (% class="box warningmessage" %) | ||
| 8 | ((( | ||
| 9 | [[image:https://doc.aagon.com/bin/download/XWiki/Aagon%20Warnungsbox/WebHome/Warning.svg||alt="Warning" height="32" width="32"]] **Achtung: ** | ||
| 10 | |||
| 11 | Sie können nicht direkt über Parameter auf die Eigenschaften des Cmdlets (z.B. "FamilyName", "Email", usw.) zugreifen, da es sich bei den Eigenschaften nicht um Parameter handelt. | ||
| 12 | ))) | ||
| 13 | |||
| 14 | Welcher Datentyp in welchem Cmdlet verwendet werden muss, können Sie sich über die Hilfe des jeweiligen Cmdlets anzeigen lassen. | ||
| 15 | |||
| 16 | === Beispiel 1 === | ||
| 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 | "}} | ||
| 50 | PS C:\Program Files (x86)\Aagon\AESB Shell> Get-Help Acmp-SaveContacts_V3 | ||
| 51 | |||
| 52 | NAME | ||
| 53 | Acmp-SaveContacts_V3 | ||
| 54 | |||
| 55 | SYNTAX | ||
| 56 | Acmp-SaveContacts_V3 [[-ConnectionName] <string>] [-Contacts <List[TContact_V3]>] [-AcmpServerId <string>] [-Timeout <int>] [<CommonParameters>] | ||
| 57 | |||
| 58 | |||
| 59 | ALIASES | ||
| 60 | None | ||
| 61 | |||
| 62 | |||
| 63 | REMARKS | ||
| 64 | None | ||
| 65 | {{/code}} | ||
| 66 | |||
| 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 | |||
| 69 | === Beispiel 2 === | ||
| 70 | |||
| 71 | {{code language="PowerShell" layout="LINENUMBERS" title="**Beispiel: Speichern von Kontakten**"}} | ||
| 72 | |||
| 73 | # Erstellen einer Liste | ||
| 74 | $contacts = @() | ||
| 75 | |||
| 76 | # Erstellen eines Kontakts | ||
| 77 | $testContact = New-TContact_V3 | ||
| 78 | $testContact.ID = [guid]::NewGuid().ToString() | ||
| 79 | $testContact.Name = "Max" | ||
| 80 | $testContact.FamilyName = "Musterman" | ||
| 81 | $testContact.Email = "mmusterman@testmail.de" | ||
| 82 | |||
| 83 | # Hinzufügen des Kontakts zur Liste | ||
| 84 | $contacts += $testContact | ||
| 85 | |||
| 86 | # Ausführen des Public Api commands | ||
| 87 | $result = Acmp-SaveContacts_V3 -Contacts $contacts | ||
| 88 | |||
| 89 | # Ausgabe des results | ||
| 90 | $result | ||
| 91 | |||
| 92 | |||
| 93 | FirstErrorMsg ResultCode ResultMessage | ||
| 94 | ------------- ---------- ------------- | ||
| 95 | 0 OK | ||
| 96 | {{/code}} | ||
| 97 | |||
| 98 | Anhand der Antwort der Public API ist eine Fehlerbehandlung möglich. | ||
| 99 | |||
| 100 |