Diary API

Action	Endpoint
Fetch Latest Diary Entry By Locator	GET/auxdata/{tenantLocator}/diary/{locator}/latest
Fetch Latest Diary Entries By Reference	GET/auxdata/{tenantLocator}/diary/{referenceType}/{referenceLocator}
Fetch All Diary Entries By Locator	GET/auxdata/{tenantLocator}/diary/{locator}
Create Diary	POST/auxdata/{tenantLocator}/diary/{referenceType}/{referenceLocator}
Create Diary For Segment Element	POST/auxdata/{tenantLocator}/diary/segments/{segmentLocator}/element/{staticElementLocator}
Create Diary For Quote Element	POST/auxdata/{tenantLocator}/diary/quotes/{quoteLocator}/element/{staticElementLocator}
Update Diary	PATCH/auxdata/{tenantLocator}/diary/{locator}
Discard Diary	PATCH/auxdata/{tenantLocator}/diary/{locator}/discard

Fetch

Fetch Latest Diary Entry By Locator

Fetch Latest Diary Entry By LocatorfetchLatestDiaryEntryByLocator

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

Fetches the latest revision of a single diary entry

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:DiaryEntryResponse

Security Group:diary

Permission:

read

Fetch Latest Diary Entries By Reference

Fetch Latest Diary Entries By ReferencefetchLatestDiaryEntriesByReference

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

Fetches all of the latest revisions for a given entity

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`referenceType`	path	`string`	Yes
`referenceLocator`	path	`ulid`	Yes
`includeDiscarded`	query	`boolean?`	No

Response:DiaryEntryResponse[]

Security Group:diary

Permission:

read

Fetch All Diary Entries By Locator

Fetch All Diary Entries By LocatorfetchAllDiaryEntriesByLocator

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

Fetches all revisions of a single diary entry

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:DiaryEntryResponse[]

Security Group:diary

Permissions:

read,list

DiaryEntryResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`referenceLocator`	`ulid`
`diaryState`	`Enum active \| discarded`
`contents`	`string`
`referenceType`	`Enum quote \| policy \| transaction \| task \| fnol \| invoice \| account \| underwritingFlag \| payment \| quoteGroup \| inquiry \| element`
`updatedAt`	`datetime`
`updatedBy`	`uuid`
`createdAt`	`datetime`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`category`	`string?`

Creation

Create Diary

Create DiarycreateDiary

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`referenceType`	path	`string`	Yes
`referenceLocator`	path	`ulid`	Yes

Request:DiaryEntryCreateRequest

Response:DiaryEntryResponse

Security Group:diary

Permission:

write

Create Diary For Segment Element

Create Diary For Segment ElementcreateDiaryForSegmentElement

POST/auxdata/{tenantLocator}/diary/segments/{segmentLocator}/element/{staticElementLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`segmentLocator`	path	`ulid`	Yes
`staticElementLocator`	path	`ulid`	Yes

Request:DiaryEntryCreateRequest

Response:DiaryEntryResponse

Security Group:diary

Permission:

write

Create Diary For Quote Element

Create Diary For Quote ElementcreateDiaryForQuoteElement

POST/auxdata/{tenantLocator}/diary/quotes/{quoteLocator}/element/{staticElementLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`quoteLocator`	path	`ulid`	Yes
`staticElementLocator`	path	`ulid`	Yes

Request:DiaryEntryCreateRequest

Response:DiaryEntryResponse

Security Group:diary

Permission:

write

DiaryEntryCreateRequest

Required properties

Property	Type	Description
`contents`	`string`

Optional properties

Property	Type	Description
`category`	`string?`

Revisioning

Update Diary

Update DiaryupdateDiary

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:DiaryEntryUpdateRequest

Response:DiaryEntryResponse

Security Group:diary

Permission:

write

DiaryEntryUpdateRequest

Required properties

Property	Type	Description
`contents`	`string`

Optional properties

Property	Type	Description
`category`	`string?`

Discard

Discard Diary

Discard DiarydiscardDiary

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:DiaryEntryResponse

Security Group:diary

Permission:

write

Diary API

Fetch

Fetch Latest Diary Entry By Locator

Fetch Latest Diary Entries By Reference

Fetch All Diary Entries By Locator

Creation

Create Diary

Create Diary For Segment Element

Create Diary For Quote Element

Revisioning

Update Diary

Discard

Discard Diary

See Also

On this page