Wiki source code of Verwenden der ACMP Public API
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{aagon.floatingbox/}} | ||
| 2 | |||
| 3 | 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. | ||
| 4 | |||
| 5 | = Aufbau von Cmdlets der ACMP Public API = | ||
| 6 | |||
| 7 | 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//. | ||
| 8 | |||
| 9 | (% class="box warningmessage" %) | ||
| 10 | ((( | ||
| 11 | [[image:https://doc.aagon.com/bin/download/XWiki/Aagon%20Warnungsbox/WebHome/Warning.svg||alt="Warning" height="32" width="32"]] **Achtung: ** | ||
| 12 | |||
| 13 | 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. | ||
| 14 | ))) | ||
| 15 | |||
| 16 | Welcher Datentyp in welchem Cmdlet verwendet werden muss, können Sie sich über die Hilfe des jeweiligen Cmdlets anzeigen lassen. | ||
| 17 | |||
| 18 | === Beispiel 1: Get-Help === | ||
| 19 | |||
| 20 | {{apimacro title="Get-Help"}} | ||
| 21 | {{code language="PowerShell"}} | ||
| 22 | PS C:\Program Files (x86)\Aagon\AESB Shell> Get-Help Acmp-SaveContacts_V3 | ||
| 23 | |||
| 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}} | ||
| 38 | {{/apimacro}} | ||
| 39 | |||
| 40 | 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. | ||
| 41 | |||
| 42 | === Beispiel 2: Speichern von Kontakten === | ||
| 43 | |||
| 44 | {{apimacro title="Speichern von Kontakten"}} | ||
| 45 | {{code language="PowerShell" layout="LINENUMBERS"}} | ||
| 46 | |||
| 47 | # Erstellen einer Liste | ||
| 48 | $contacts = @() | ||
| 49 | |||
| 50 | # Erstellen eines Kontakts | ||
| 51 | $testContact = New-TContact_V3 | ||
| 52 | $testContact.ID = [guid]::NewGuid().ToString() | ||
| 53 | $testContact.Name = "Max" | ||
| 54 | $testContact.FamilyName = "Musterman" | ||
| 55 | $testContact.Email = "mmusterman@testmail.de" | ||
| 56 | |||
| 57 | # Hinzufügen des Kontakts zur Liste | ||
| 58 | $contacts += $testContact | ||
| 59 | |||
| 60 | # Ausführen des Public Api commands | ||
| 61 | $result = Acmp-SaveContacts_V3 -Contacts $contacts | ||
| 62 | |||
| 63 | # Ausgabe des results | ||
| 64 | $result | ||
| 65 | |||
| 66 | |||
| 67 | FirstErrorMsg ResultCode ResultMessage | ||
| 68 | ------------- ---------- ------------- | ||
| 69 | 0 OK | ||
| 70 | {{/code}} | ||
| 71 | {{/apimacro}} | ||
| 72 | |||
| 73 | Anhand der Antwort der Public API ist eine Fehlerbehandlung möglich. | ||
| 74 | |||
| 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 | |||
| 80 |