Syntax: GET /rest/v1/record/<recordKey>
Dieser Aufruf dient dem Abruf eines konkreten Datensatzes.
Parameter
| Name | Pflicht | Beschreibung |
|---|---|---|
| recordKey | Ja | Oid oder MigrationId eines existierenden Datensatzes (Vererbung: OrmBABase). |
Mögliche Rückgabestatus
| Status | Beschreibung |
|---|---|
| 200 OK | Die gewünschten Daten wurden im Antwortinhalt übertragen. |
| 304 Not modified | Die angegebene Anfragebedingung wird nicht erfüllt. |
| 403 Forbidden | Der aktuelle Benutzer hat nicht die Berechtigung den angegebenen Datensatz zu lesen. |
| 404 Not found | Der gewünschte Datensatz konnte nicht ermittelt werden. |
| 500 Internal server error | Bei der Verarbeitung kam es zu einem unvorhergesehenen Fehler. |
Rückgabe
Der Aufruf liefert die belegten Inhalte des angefragten Datensatzes in Form eines JSON-Dictionarys zurück, das bedeutet: Das Ergebnis ist ein JSON-Objekt, dessen Eigenschaften mit den Namen derjenigen Felder identisch sind, die über den typeinfo-Endpunkt abgefragt werden können und die innerhalb dieses konkreten Datensatzes Werte beinhalten. Leere Felder werden nicht zurückgeliefert um das Übertragungsvolumen zu minimieren.
Standardfelder (Text, Zahlen, Boolean)
Diese Felder werden als einfache Zuordnung des entsprechenden Werts zurückgegeben.
Beispiele:
"Address": "Chemnitzer Straße 98"
"CreditBlocking": true
Datumswerte
Datumswerte werden in JavaScript-konformem Format (ISO 8601) geliefert.
Beispiel:
"Created": "2022-08-02T09:44:30.5715234+02:00"
Unterstützt das Feld Wiederholungen, so wird der Wert in einer JSON-Struktur zurückgegeben, welche auch die Wiederholungsinformationen beinhaltet. Dies geschieht auch, wenn der Wert an sich keine Wiederholungsinformationen hat.
"RepeatDate": {
"Value": "2022-08-02T09:44:30.5715234+02:00",
"RecurrenceInfo": "(XML)",
"RecurrenceType":1
}Relationsdaten/Verknüpfungsdaten
Diese Daten werden entweder als einzelnes Objekt oder als Liste von Objekten (s. typeinfo) zurückgegeben, deren Eigenschaften die Oid und einen Anzeigewert (Display) des verknüpften Datensatzes beinhalten.
Beispiel:
"CreatedBy": {
"Oid": "bbc4f200-1b49-4920-b0a5-11e0412b2bae",
"Display": "System User"
}Dateianhangsfelder
Dateianhangsfelder enthalten nur eine Liste mit Referenzen auf Dateianhängen. Metadaten von Dateianhängen müssen gesondert abgefragt werden.
Beispiel:
"DefaultAttachments": [
"bb81e1a6-c082-4afd-8cb8-a0f7fdaec776"
]Auswahlistenwerte
Felder mit Auswahllistenwerten enthalten alle Informationen dieses Auswahllistenwertes, das heißt seine Id, alle Übersetzungen und alle zusätzlichen Felder, die diese Auswahlliste definiert.
Beispiel:
"Country": {
"Oid": "bac53e30-797b-4ba0-802b-b4bc7700d590",
"Language_de": "Deutschland",
"Language_en": "Germany",
"ISOCode": "DE",
"FormatSalutation": "{ Cpa_GetCompanyField fieldName=\"Name\" }\\n{ Salutation trim=\"right\" } { Titles separator=\" \" trim=\"right\" } { FirstName trim=\"right\" } { MiddleName trim=\"right\" } { LastName } { Suffix }",
"FormatAddress": "{ Address }\\n{ AdditionalAddress1 }\\n{ PostalCode trim=\"right\" } { City }\\n{ Country }",
"FormatLetterSalutationMale": "Sehr geehrter { Salutation } { SalutationTitle } { LastName }",
"FormatLetterSalutationFemale": "Sehr geehrte { Salutation } { SalutationTitle } { LastName }",
"FormatLetterSalutationNeutral": "Sehr geehrte Damen und Herren",
"FormatLetterClosing": "Mit freundlichen Grüßen"
}Teildatentabellen
Für Teiltabellen werden Listen mit Teildatensätzen zurückgeliefert, welche aus den Typinformationen der entsprechenden Teiltabellen erstellt werden.
Beispiel:
"Addresses": [
{
"Address": "Chemnitzer Straße 98",
"AddressType": {
"Oid": "eb7852ef-9ba5-47f6-ab68-82fb891a2943",
"Language_de": "Hauptanschrift",
"Language_en": "Main address"
},
"City": "Dortmund",
"Country": {
"Oid": "bac53e30-797b-4ba0-802b-b4bc7700d590",
"Language_de": "Deutschland",
"Language_en": "Germany",
"ISOCode": "DE",
"FormatSalutation": "{ Cpa_GetCompanyField fieldName=\"Name\" }\\n{ Salutation trim=\"right\" } { Titles separator=\" \" trim=\"right\" } { FirstName trim=\"right\" } { MiddleName trim=\"right\" } { LastName } { Suffix }",
"FormatAddress": "{ Address }\\n{ AdditionalAddress1 }\\n{ PostalCode trim=\"right\" } { City }\\n{ Country }",
"FormatLetterSalutationMale": "Sehr geehrter { Salutation } { SalutationTitle } { LastName }",
"FormatLetterSalutationFemale": "Sehr geehrte { Salutation } { SalutationTitle } { LastName }",
"FormatLetterSalutationNeutral": "Sehr geehrte Damen und Herren",
"FormatLetterClosing": "Mit freundlichen Grüßen"
},
"PostalCode": "44139"
}
]Zusammenhängendes Beispiel
{
"Created": "2022-08-02T09:44:30.5715234+02:00",
"Modified": "2022-09-09T13:23:10.2153237+02:00",
"CreatedBy": {
"Oid": "bbc4f200-1b49-4920-b0a5-11e0412b2bae",
"Display": "System User"
},
"ModifiedBy": {
"Oid": "6a1ab622-2c16-4d80-a868-bfae0ccfaee7",
"Display": "Johannes Erk"
},
"_inlineimages_": [
"e6466a47-1dac-4b37-91d5-3364a5da399f"
],
"Addresses": [
{
"Address": "Chemnitzer Straße 98",
"AddressType": {
"Oid": "eb7852ef-9ba5-47f6-ab68-82fb891a2943",
"Language_de": "Hauptanschrift",
"Language_en": "Main address"
},
"City": "Dortmund",
"Country": {
"Oid": "bac53e30-797b-4ba0-802b-b4bc7700d590",
"Language_de": "Deutschland",
"Language_en": "Germany",
"ISOCode": "DE",
"FormatSalutation": "{ Cpa_GetCompanyField fieldName=\"Name\" }\\n{ Salutation trim=\"right\" } { Titles separator=\" \" trim=\"right\" } { FirstName trim=\"right\" } { MiddleName trim=\"right\" } { LastName } { Suffix }",
"FormatAddress": "{ Address }\\n{ AdditionalAddress1 }\\n{ PostalCode trim=\"right\" } { City }\\n{ Country }",
"FormatLetterSalutationMale": "Sehr geehrter { Salutation } { SalutationTitle } { LastName }",
"FormatLetterSalutationFemale": "Sehr geehrte { Salutation } { SalutationTitle } { LastName }",
"FormatLetterSalutationNeutral": "Sehr geehrte Damen und Herren",
"FormatLetterClosing": "Mit freundlichen Grüßen"
},
"PostalCode": "44139"
}
],
"AttachmentState": {
"Oid": "b175abd7-a94f-47dc-8709-652773f7bc4d",
"Language_de": "Enthält Anhänge",
"Language_en": "Contains attachments"
},
"Category": {
"Oid": "8d9a4c35-9bd0-4ca9-aad1-88e8659812af",
"Language_de": "Kunde",
"Language_en": "Customer"
},
"CommunicationStatus": [
{
"Oid": "2b620e44-f7fe-438d-a046-52ded2db30e0",
"Language_de": "Keine Werbung zulassen",
"Language_en": "No advertising allowed"
}
],
"CompanyNumber": "80037",
"CreditBlocking": true,
"DefaultAttachments": [
"bb81e1a6-c082-4afd-8cb8-a0f7fdaec776"
],
"Description": "<p>Mit Inline:</p><p><img src=\"cid:c6648fa9-67aa-4199-b8ab-6ead4d026395@localhost\" alt=\"\"><br /></p>",
"IsActive": true,
"MailingLists": [
{
"Oid": "2ec3da56-d82e-4810-bf82-6788fc2155e1",
"Language_de": "Infoverteiler Allgemein",
"Language_en": "Mailing list info general"
}
],
"MigrationID": "58680-DZAR-6KQL2E|Company|Contacts_DACH",
"Name": "A. Huber Wurstfabrik OHG",
"OrmType": {
"Oid": "fe7eb8ae-71be-4220-8da5-dc04078e6b3c",
"Language_de": "Firma",
"Language_en": "Company"
},
"Phone": "-194722",
"SearchNames": "A. Huber Wurstfabrik OHG",
"Common_EntityTitle": "A. Huber Wurstfabrik OHG",
"RelatedCreatedBy": [
{
"Oid": "bbc4f200-1b49-4920-b0a5-11e0412b2bae",
"Display": "System User"
}
]
}