A "Domain" generally refers to a physical table in the Origami data model. Sometimes called an "Entity" or an "Area", Domains are found throughout the Origami interface as types of information. Common examples are Claims, Contacts, Locations, Checks, etc. See Origami help center for more detailed information.
Heads-up on Custom domains. Custom domains include a period in the name (such as Custom.MyObjectName).
When interacting with the API where there types of domains are in the request URL, be sure to end the URL with a forward slash (/). This trailing slash helps the system interpret the domain correctly and keeps things running smoothly.
For example: your custom domain is Custom.MyObjectName
✅ Correct: https://{environment}.origamirisk.com/OrigamiApi/api/Custom.MyObjectName/
❌ Incorrect: https://{environment}.origamirisk.com/OrigamiApi/api/Custom.MyObjectName
Useful Guidelines for structuring your input data when interacting with Domains
Case Sensitivity
- Domain names and field names are case sensitive.
Date Fields
- Values should follow the yyyy-MM-dd format. Do not include time for date fields.
Time Fields
- Values can use either:
- Military time format: HH:mm
- 12-hour clock format: hh:mm am/pm
Coded Fields
- Values can be passed using either the display code or description. The internal ID is only required when using the coded ID property name (e.g., CustomCode1ID).
Multi-Select Coded Fields
- Recommended to pass display codes, separated by commas for multiple values.
Boolean Fields
- Acceptable formats include: Yes/No, True/False, Y/N, or 1/0.
Both Domain Names and Field Names are case sensitive.
Date field values are expected to have a yyyy-MM-dd format. Do not include time for date fields.
Time field values are expected to have either a military time HH:mm format or a 12 hour clock hh:mm am/pm format.
Coded field values can pass either the Display Code or Description for the field. You do not need to know the internal ID value for the code unless you're using the coded ID property name (i.e. CustomCode1ID).
MultiSelect Coded field values are recommended to pass the Display Code with commas separating multiple values.
Boolean (Yes/No) field values can be passed in the format of Yes/No, True/False, Y/N, or 1/0.