Get the Notes Associated with a Domain Record

get

https://{environment}.origamirisk.com/OrigamiApi/api/{domain}/{id}/Notes

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Retrieves notes associated with a specified parent record. Parent records can include any primary domain entity such as claims, policies, quotes, or other core objects. You must specify the set of columns to return. An optional filter can be applied to narrow the results based on specific criteria.

Path Params

domain

string

required

This should match to the Domain Name in the system. It is case-sensitive. For Client Defined Entities it should start with 'Custom.'

string

required

Numeric primary identifier for the record whose notes are being retrieved.

Query Params

columns

string

required

Defaults to NoteID,Body as Note Body

A comma separated list of the columns to be returned. You can optionally indicate an alias for the return results by putting ' as ' after the property name and then including the desired alias.

filter

string

Record filter criteria in the Origami Advanced Search syntax.

sort

string

Columns to sort by. Similar syntax to sorting in Views.

startAt

integer

Default is 0. If you are fetching subsequent pages of data indicate the record to start with.

take

integer

Default result set is 30 records. There is a maximum cap so this cannot be unlimited.

LINQFilter

string

Optional record filter criteria in C# LINQ syntax. Only to be used in cases where filter syntax does not meet needs.

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200