4.9.4.1.2. Methode: POST

Syntax: POST /rest/v1/record/<ormType>

Dieser Aufruf erstellt einen neuen Datensatz des angegebenen Typs.

Parameter

Mögliche Rückgabestatus

Rückgabe

Nach erfolgreicher Erstellung des Datensatzes liefert die Anfrage ein JSON-Objekt zurück, welches in den Eigenschaften Oid die Oid des neuen Datensatzes und in OrmType den Datentypen beinhaltet. Sollten nach erfolgter Erstellung des Datensatzes nachgelagert Fehler aufgetreten sein, enthält die Eigenschaft Errors eine Liste mit entsprechenden Standardfehlerdatensätzen. In diesem Fall sollten Oid und OrmType nicht verwendet werden, da sie ungülte Werte enthalten könnten.

Beispiel bei erfolgreicher Erstellung:

{
    "Oid": "066b3156-8a49-4439-8850-10f038dcf75b",
    "OrmType": "fe7eb8ae-71be-4220-8da5-dc04078e6b3c",
    "Errors": []
}

Besonderheiten bezüglich des Anfrageinhalts

Standardfelder (Text, Zahlen, Boolean)

Diese Felder werden als einfache Zuordnung des entsprechenden Werts übergeben. Für Felder des Typs Boolean können entweder true oder false oder aber auch 0 oder 1 verwendet werden.

Beispiele:

"searchnames": "Meine Firma"
"CreditBlocking": true oder "CreditBlocking": 1

Datumswerte

Datumswerte müssen in JavaScript-konformem Format (ISO 8601) übergeben werden.

Beispiel:

"EndDate": "2022-08-02T09:44:30.5715234+02:00"

Wenn das Dautmsfeld Wiederholungen erlaubt, ist es möglich (aber nicht zwingend notwendig) diese Wiederholungsinformationen in einem JSON-Objekt zusammen mit dem zu setzenden Datumswert zu übergeben. Der Datumswert muss dann in der Eigenschaft Value und die Wiederholungsinformation in der Eigenschaft RecurrenceInfo stehen. Der von der GET-Methode zurückgegebene zusätzliche Wert RecurrenceType kann nicht gesetzt werden; er wird automatisch auf 0 oder@1@ gesetzt, je nachdem ob Wiederholungsinformationen vorhanden sind oder nicht.

Beispiel:

"RepeatDate": {
    "Value": "2022-08-02T09:44:30.5715234+02:00",
    "RecurrenceInfo": "(gültiges XML)"
}

!Es ist nicht möglich Ausnahmen von Wiederholungen über die REST-API zu setzen.

Quellrelationsdefinitionen

Diese Daten können als Einzelwert oder als Liste von Oids oder MigrationIds verknüpfter Datensätze übergeben werden. Es sind die möglichen Datenquellen aus typeinfo zu beachten!

Beispiel:

"RelatedCustom_ParentCompany": "596063d0-c741-4d32-820a-72c6f63ed94f"

Dateianhangsfelder

Die Inline-erstellung von Dateianhängen wird unterstützt aber aufgrund der Komplexität nicht empfohlen. Beim Setzen von Dateianhängen müssen die Eigenschaften FileName als Dateiname und Data angegeben werden, die Eigenschaften IsInline, Subject und ContentID sind optional (ist IsInline true so ist ContentID Plicht). Die Daten müssen derweil als BASE64 codierter String in der Data-Eigenschaft übergeben werden.

Die Inline-Erstellung hat den Vorteil, dass sie die gleichzeitige Erstellung mehrer Dateianhänge unterstützt.

Beispiel:

"DefaultAttachments": [
    {
        "FileName": "Konzept.docx",
        "Subject": "Das ist ein Konzept!",
        "Data" : "..."
    }
]

Auswahlistenwerte

Auswahllistenwerte können sowohl anhand ihrer Guid als auch anhand einer vollständigen Übersetzung identifiziert und ebenfalls auf verschiedene Arten übergeben werden. Sowohl Guids als auch Übersetzungen können sowohl als einzelner String-Wert kommagetrennt als auch als Liste einzelner Werte übergeben werden. Des Weiteren können bei Auswahllisten, welche dies unterstützen, auch neue Werte erstellt werden. In diesem Fall wird entweder, bei Angabe eines einzelnen Strings, der übergebene Text als Übersetzung aller konfigurierter Sprachen verwendet, es ist aber auch möglich, alle Übersetzungen in einem Objekt anzugeben. BItte beachten Sie, dass Sie bei Verwendung der zuletzt genannten Methodik alle Übersetzungen angeben müssen, um den Auswahllistenwert zu erstellen. Wenn Sie möchten, dass eine ganz bestimmte Guid für den neuen Auswahllistenwert verwendet wird, so können Sie diese in der Oid-Eigenschaft angeben, es wird dann geprüft, ob diese Guid verwendet werden kann. Es ist bei der Übergabe als Objekt ebenfalls möglich, zusätzliche Eigenschaften von Auswahllistenwerten bei deren Erstellung zu belegen.

Beispiele:
Hier wird ein neuer Kommunikationsstatus erzeugt, der in allen Übersetzungen den Text “Ich will das nicht.” eingetragen bekommt.
"CommunicationStatus" : "Ich will das nicht."

Der existierende Kommunikationsstatus wird anhand seiner Übersetzung erkannt und verwendet, es wird kein neuer Eintag erstellt.
"CommunicationStatus" : "Keine Werbung"

Sollte ein Kommunikationstatus mit dieser Guid existieren, so wird er verwendet, wenn nicht, wird er ignoriert (es wird aktuell nicht unterstützt neue Auswhallistenwerte mit einer Guid als Übersetzung zu erstellen!).
"CommunicationStatus" : "596063d0-c741-4d32-820a-72c6f63ed94f"

Es ist möglich, mehrere Auswahllistenwerte durch Komma getrennt in einer Zeile anzugeben, die Suche nach einer Übersetzung ignoriert übrigens Groß-/Kleinschreibung.
"CommunicationStatus" : "596063d0-c741-4d32-820a-72c6f63ed94f,Keine werBUNG"

Das vorige Beispiel kann auch als Liste übergeben werden.
"CommunicationStatus" : [ "596063d0-c741-4d32-820a-72c6f63ed94f", "Keine werBUNG" ]

Das folgende ist eins der komplizierteren Beispiele:
Für ein Feld namens “Country” mit der potenziell verknüpften Auswahlliste EnumCountries wird ein neuer Auswahllistenwert erstellt. Der Auswahllistenwert hat eine Wunsch-Oid, kann diese nicht gesetzt werden, wird ein entsprechender Fehler zurückgegeben. Die Oid-Eigenschaft ist kein Pflichtfeld. Im System sind die Sprachen Deutsch und Englisch konfiguriert, für alle Sprachen muss eine eindeutige Übersetzung angegeben werden; es ist nicht möglich, einen neuen Auswahllistenwert mit in dieser Auswahlliste bereits verwendeten Übersetzungen zu erstellen! Weiterhin werden zwei zusätzliche Eigenschaften des Auswahllistenwertes belegt.

"Country" : {
    "Oid" : "596063d0-c741-4d32-820a-72c6f63ed94f",
    "Language_de" : "Mein Land",
    "Language_en" : "My country",
    "ISOCode" : "MCO",
    "FormatLetterClosing" : "Wiedersehen!"
}

Teildatentabellen

Teildatensätze werden als Liste mit Objekten mit den entsprechenden Eigenschaften der Teildatentabelle erstellt.

Beispiel:

"Addresses": [
    {
        "Address": "Chemnitzer Straße 98",
        "AddressType": "Hauptanschrift",
        "City": "Dortmund",
        "Country": "bac53e30-797b-4ba0-802b-b4bc7700d590",
        "PostalCode": "44139"
    }
]