Get a Single Record from a Domain

get

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

This is the primary endpoint for fetching the full detail of an individual record when you already know its ID.

Retrieves a single entity record by its primary key. This endpoint returns the field values for a specific record on the specified domain, identified by its unique numeric ID.

By default, all in-use database columns are returned, but you can optionally specify a subset of columns or associated fields to limit the response payload.

Path Params

domain

string

required

This is the Domain Name as identified in the response of the /api/Domains endpoint. Ex: the "Claims" domain (DomainID 1) would be referenced by its name value of Claim. Values are case-sensitive. Client-defined Domains should start with "Custom."

integer

required

This is the unique identifier of the domain resource you are requesting. For example, if you are getting a Claim then the id will be the Claim ID

Query Params

columns

string

This field lets you control which columns (fields) come back in the API response and what they are called.

If not provided, then all fields on the record are returned.

Here is what each part means:

1. Choose which columns you want

You pass a comma separated list of field names.

Example:
Location.Name, ClaimNumber, LossDate

If you do not pass anything, the API will return all columns it normally uses.

2. Rename columns using aliases

You can rename a column in the response by adding as AliasName.

Example:
Location.Name as LocationName

This means:

The API reads data from Location.Name
The response JSON will contain LocationName

This is helpful to:

Make names shorter
Avoid dots in response keys
Match frontend or reporting naming conventions

3. Referencing related or coded fields

Some fields are associations or coded values. These do not return anything unless you ask for a specific property on them.

Example:

Custom2Code → returns null
Custom2Code.Description → returns the human readable text

So:

The code object itself does not have a direct value
You must request a specific attribute of it, like Description, Code, etc.

4. Putting it all together

Example query:
Location.Name as LocationName, Custom2Code.Description as CustomReason

Result:

You get only the fields you asked for
You control the field names in the response
You correctly extract values from coded or related fields

resolveAssociationNames

boolean

Defaults to false

This input modifies how values are returned for the columns parameter.
Most columns will represent individual fields that are retrieved directly from the record being queried. However, in some cases you may want to name a related "object" as a column you wish to retrieve. These are referred to as association fields.

When resolveAssociationNames is set to true, the API will attempt to resolve any requested association fields and return a readable, display-friendly value for them. When set to false (or omitted), association fields will return null unless the record natively stores a value for that column.

Understanding association fields

This has useful roots stemming from Origami's intuitive UI, where data is often presented in tables that list default "columns" for a given record type. While these columns appear as simple fields in the UI/table, some of them are actually representations of related records.

For example, a Claim is associated with a Location. In tables, Location appears as a single column, but the Claim record itself does not store the Location’s descriptive information. Instead, it stores only a reference (such as LocationID) to the related Location record. The readable Location value shown in the UI (for example, LocationNumber - Name) is constructed from multiple fields on that related Location record.
Because these relationship-based values are surfaced as columns, it is reasonable for API consumers to request them as if they were simple fields. Association resolution exists to support this usage and return meaningful data rather than an empty value.

Behavior when association resolution is enabled

When resolveAssociationNames=true and a requested column is an association field:

The API interprets the request as an intent to retrieve the displayed value for the related/associated record.

The related record is looked up using the stored reference (for example, LocationID).

If the related record can be resolved, the API returns a readable string representation (such as LocationNumber - Name).

If the related record cannot be found, the value will remain null.

This mirrors how related values are displayed throughout Origami tables and reports.

Examples

Without association resolution
GET /api/Claim/Query?columns=IncidentID,LocationID,Location

Sample Reponse:
{
  "IncidentID": 10752,
  "LocationID": 22177,
  "Location": null
}

With association resolution
GET /api/Claim/Query?columns=IncidentID,LocationID,Location&resolveAssociationNames=true

{
  "IncidentID": 10752,
  "LocationID": 22177,
  "Location": "35 - Chicago"
}

Response

Overview

1. Choose which columns you want

2. Rename columns using aliases

3. Referencing related or coded fields

4. Putting it all together

200