Diary API

Fetch

Fetch Latest Diary Entry By Locator

fetchLatestDiaryEntryByLocator

Fetches the latest revision of a single diary entry

GET /auxdata/{tenantLocator}/diary/{locator}/latest

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required

Response:DiaryEntryResponse
Security Group:diary   Permission:read

Fetch Latest Diary Entries By Reference

fetchLatestDiaryEntriesByReference

Fetches all of the the latest revisions for a given entity

GET /auxdata/{tenantLocator}/diary/{referenceType}/{referenceLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
referenceType	path	Enum policies | quotes | transactions	required
referenceLocator	path	locator	required
includeDiscarded	query	boolean?	optional

Response:DiaryEntryResponse[]
Security Group:diary   Permission:read

Fetch All Diary Entries By Locator

fetchAllDiaryEntriesByLocator

Fetches all revisions of a single diary entry

GET /auxdata/{tenantLocator}/diary/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required
offset	query	int?	optional
count	query	int?	optional

Response:DiaryEntryResponse[]
Security Group:diary   Permissions:read,list

DiaryEntryResponse

required
locator locator
referenceLocator locator
diaryState Enum active | discarded
contents string
referenceType Enum quote | policy | transaction | activity
updatedAt datetime
updatedBy uuid
createdAt datetime
createdBy uuid

optional
category string?

Creation

Create Diary

createDiary

POST /auxdata/{tenantLocator}/diary/{referenceType}/{referenceLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
referenceType	path	Enum policies | quotes | transactions	required
referenceLocator	path	locator	required

Request:DiaryEntryCreateRequest
Response:DiaryEntryResponse
Security Group:diary   Permission:write

DiaryEntryCreateRequest

required
contents string

optional
category string?

Revisioning

Update Diary

updateDiary

PATCH /auxdata/{tenantLocator}/diary/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required

Request:DiaryEntryUpdateRequest
Response:DiaryEntryResponse
Security Group:diary   Permission:write

DiaryEntryUpdateRequest

required
contents string

optional
category string?

Discard

Discard Diary

discardDiary

PATCH /auxdata/{tenantLocator}/diary/{locator}/discard

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required

Response:DiaryEntryResponse
Security Group:diary   Permission:write

See Also

• Diaries Feature Guide