/Employees/{employeeNumber}/Journals
Description
Reads all journals assigned to a staff member.
- The right ‘Lesen’ is required for the data ‘Journal’.
Request
URI Parameters
employeeNumber
string
Required
Die Mitarbeiternummer
JournalId
globally unique identifier
Journal ID
ContactKindId
integer
Contact type ID
StatusId
integer
Status ID
CategoryId
integer
Category ID
OnlyMyEntries
boolean
Show only own entries
EmployeeNumber
string
Employee number
DueDate
date
Deadline on
AssignedUser
string
Responsible user
Page
integer
Page number for paging | Default: 0
Items
integer
Sets the number of entries per page | Default: 10 | All: 0
SearchTerm
string
Filter for words
SearchIn
string
Properties in which to search. The separator between these properties is "|".
OrderBy
string
Properties to be sorted by. An exclamation mark ! at the end indicates downward sorting. To sort by several properties, they must be separated by a "|".
Filter
string
A filter can be defined to limit the result set. For example: (Property EQ Value OR Property2 GT Value2) AND (Property3 CT 'String') See the description for the FilterQueryLanguage for more information.
Body Parameters
None.
Response
Resource Description
ROW
integer
RecordId of the record
Identifier
globally unique identifier
Journal identifier
Date
date
Erforderlich
Journal date
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
Type of repetition of a journal
CategoryId
integer
[Category].Id
Label
string
Erforderlich
Name
Text
string
Erforderlich
Description
IsPrivateContact
boolean
Indication of whether it is a private contact
ResponsiblePerson
string
Password abbreviation of the person in charge
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
Record information, e.g. creation date, processing date
CustomFields
User defined fields
Response Formats
application/json
Example:
[
{
"ROW": 1,
"Identifier": "08d0b52e-23e8-4022-a9a9-82eaa6a2a138",
"Date": "2024-12-26T19:59:39.7256128+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-12-26T19:59:39.7256128+01:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-12-26T19:59:39.7256128+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-12-26T19:59:39.7256128+01:00",
"Date2": "2024-12-26T19:59:39.7256128+01:00",
"Flag1": true,
"Flag2": true,
"Flag3": true,
"Flag4": true
}
},
{
"ROW": 1,
"Identifier": "08d0b52e-23e8-4022-a9a9-82eaa6a2a138",
"Date": "2024-12-26T19:59:39.7256128+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-12-26T19:59:39.7256128+01:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-12-26T19:59:39.7256128+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-12-26T19:59:39.7256128+01:00",
"Date2": "2024-12-26T19:59:39.7256128+01:00",
"Flag1": true,
"Flag2": true,
"Flag3": true,
"Flag4": true
}
}
]