/Documents/{documentKey}/Journals
Beschreibung
Liest Journale eines bestimmten Beleges aus
- Es wird das Recht "Lesen" für die Daten "Journal" benötigt.
Request
URI Parameters
documentKey
string
Erforderlich
JournalId
globally unique identifier
Journal-ID
ContactKindId
integer
Kontaktart-ID
StatusId
integer
Status-ID
CategoryId
integer
Kategorie-ID
OnlyMyEntries
boolean
Nur eigene Einträge zeigen
EmployeeNumber
string
Mitarbeiternummer
DueDate
date
Termin am
AssignedUser
string
Zuständiger Benutzer
Page
integer
Seitennummer für das Paging | Standard: 0
Items
integer
Bestimmt die Anzahl der Einträge pro Seite | Standard: 10 | Alle: 0
SearchTerm
string
Filter für Wörter
SearchIn
string
Eigenschaften, in denen gesucht werden soll. Trenner zwischen diesen Eigenschaften ist "|".
OrderBy
string
Eigenschaften nach denen sortiert werden soll. Ein Ausrufezeichen ! am Ende gibt die Abwärtssortierung an. Um nach mehreren Eigenschaften zu sortieren, müssen diese durch ein "|" getrennt werden.
Filter
string
Es kann ein Filter definiert werden um die Ergebnismenge einzuschränken. Zum Beispiel: (Property EQ Value OR Property2 GT Value2) AND (Property3 CT 'String') Weitere Informationen finden Sie unter der Beschreibung für die FilterQueryLanguage
Body Parameters
None.
Response
Resource Description
ROW
integer
RecordId des Datensatzes
Identifier
globally unique identifier
Kennung des Journals
Date
date
Erforderlich
Datum des Journals
ContactKindIdentifier
integer
[CRM_Kontaktarten].Id
ContactKind
string
Länge: einschließlich zwischen 0 und 30
[CRM_Kontaktarten].Kontaktart, wie z.B. Notiz, Vermerk, etc.
StatusId
integer
Erforderlich
[CRM_Status].Id
Cycle
Art der Wiederholung eines Journals
CategoryId
integer
[Kategorie].Id
Label
string
Erforderlich
Bezeichnung
Text
string
Erforderlich
Beschreibung
IsPrivateContact
boolean
Angabe, ob es sich um einen Privatkontakt handelt
ResponsiblePerson
string
Passwort-Kürzel des Zuständigen
StatusLabel
string
Länge: einschließlich zwischen 0 und 30
[CRM_Status].Status, wie z.B. aufgenommen, bearbeitet, etc.
CategoryLabel
string
Länge: einschließlich zwischen 0 und 40
[Kategorie].Kategorie
MetaData
Datensatzinformationen u.a. Erstellungsdatum, Bearbeitungsdatum
CustomFields
Freie Felder
Response Formats
application/json
Beispiel:
[
{
"ROW": 1,
"Identifier": "553ca2da-db29-48c5-bcef-0caff2ce3f02",
"Date": "2024-11-24T16:36:29.452428+01:00",
"ContactKindIdentifier": 4,
"ContactKind": "sample string 5",
"StatusId": 6,
"Cycle": "None",
"CategoryId": 7,
"Label": "sample string 8",
"Text": "sample string 9",
"IsPrivateContact": true,
"ResponsiblePerson": "sample string 11",
"StatusLabel": "sample string 12",
"CategoryLabel": "sample string 13",
"MetaData": {
"CreationDate": "2024-11-24T16:36:29.452428+01:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-11-24T16:36:29.452428+01:00",
"ModificationUserToken": "sample string 2"
},
"CustomFields": {
"Text1": "sample string 1",
"Text2": "sample string 2",
"Number1": 1.1,
"Number2": 1.1,
"Number3": 1,
"Number4": 1,
"Date1": "2024-11-24T16:36:29.452428+01:00",
"Date2": "2024-11-24T16:36:29.452428+01:00",
"Flag1": true,
"Flag2": true,
"Flag3": true,
"Flag4": true
}
},
{
"ROW": 1,
"Identifier": "553ca2da-db29-48c5-bcef-0caff2ce3f02",
"Date": "2024-11-24T16:36:29.452428+01:00",
"ContactKindIdentifier": 4,
"ContactKind": "sample string 5",
"StatusId": 6,
"Cycle": "None",
"CategoryId": 7,
"Label": "sample string 8",
"Text": "sample string 9",
"IsPrivateContact": true,
"ResponsiblePerson": "sample string 11",
"StatusLabel": "sample string 12",
"CategoryLabel": "sample string 13",
"MetaData": {
"CreationDate": "2024-11-24T16:36:29.452428+01:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-11-24T16:36:29.452428+01:00",
"ModificationUserToken": "sample string 2"
},
"CustomFields": {
"Text1": "sample string 1",
"Text2": "sample string 2",
"Number1": 1.1,
"Number2": 1.1,
"Number3": 1,
"Number4": 1,
"Date1": "2024-11-24T16:36:29.452428+01:00",
"Date2": "2024-11-24T16:36:29.452428+01:00",
"Flag1": true,
"Flag2": true,
"Flag3": true,
"Flag4": true
}
}
]