Tables API

Note

Data Tables are used in plugins to support calculations. Constraint Tables are used to support UI development by filtering options for the user.

Endpoint Index

Action	Endpoint
Fetch a Table Record	GET /resource/{tenantLocator}/tables/{name}/record
Fetch a Lookup Table in ZIP Format	GET /resource/{tenantLocator}/tables/{name}
Create a Lookup Table	POST /resource/{tenantLocator}/tables
Replace a Lookup Table	PATCH /resource/{tenantLocator}/tables/{name}
Evaluate Constraints for Account	POST /policy/{tenantLocator}/accounts/{locator}/constraints/evaluate
Fetch Dependency Map for Account	GET /policy/{tenantLocator}/accounts/{locator}/constraints/dependency
Fetch Dependency Map for Quote	GET /policy/{tenantLocator}/quotes/{locator}/constraints/dependency
Evaluate Constraints for Quote	POST /policy/{tenantLocator}/quotes/{locator}/constraints/evaluate
Evaluate Constraints for Quick Quote	POST /policy/{tenantLocator}/quickquotes/{locator}/constraints/evaluate
Fetch Dependency Map for Quick Quote	GET /policy/{tenantLocator}/quickquotes/{locator}/constraints/dependency
Fetch Dependency Map for Policy Transaction	GET /policy/{tenantLocator}/transactions/{locator}/elements/constraints/dependency
Evaluate Constraints for Policy Transaction	POST /policy/{tenantLocator}/transactions/{locator}/elements/constraints/evaluate
Fetch Constraints	GET /resource/{tenantLocator}/constraints/{name}/record
Create Constraint Table	POST /resource/{tenantLocator}/constraints
Replace Constraint Table	PATCH /resource/{tenantLocator}/constraints/{name}
Zip Constraint Table	GET /resource/{tenantLocator}/constraints/{name}

Data Tables

Usage

Fetch a Table Record

fetchTableRecord

GET /resource/{tenantLocator}/tables/{name}/record

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required
date	query	datetime?	optional
byStaticName	query	boolean?	optional
key	query	string[]	required

Response:TableLookupResponse
Security Group:tables   Permission:read

TableLookupResponse

required
value object

Configuration

Fetch a Lookup Table in ZIP Format

fetchLookupTableInZipFormat

GET /resource/{tenantLocator}/tables/{name}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required

Response:StreamingResponseBody<ZipFile>
Security Group:tables   Permission:read

Create a Lookup Table

createLookupTable

POST /resource/{tenantLocator}/tables

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	query	string	required
staticName	query	string	required

Request:file
Response:BasicResourceResponse
Security Group:tables   Permission:upload

Replace a Lookup Table

replaceLookupTable

PATCH /resource/{tenantLocator}/tables/{name}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required

Request:file
Response:BasicResourceResponse
Security Group:tables   Permission:upload

Constraint Tables

Accounts

Evaluate Constraints for Account

evaluateConstraintsForAccount

POST /policy/{tenantLocator}/accounts/{locator}/constraints/evaluate

Request Parameters:

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

Request:map<string,map<string,string>>
Response:map<string,map<string,string[]>>
Security Group:accounts   Permission:read

Fetch Dependency Map for Account

fetchDependencyMapForAccount

GET /policy/{tenantLocator}/accounts/{locator}/constraints/dependency

Request Parameters:

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

Response:map<string,map<string,ConstraintDependency>>
Security Group:accounts   Permission:read

Quotes

Fetch Dependency Map for Quote

fetchDependencyMapForQuote

GET /policy/{tenantLocator}/quotes/{locator}/constraints/dependency

Request Parameters:

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

Response:map<string,map<string,ConstraintDependency>>
Security Group:quotes   Permission:read

ConstraintDependency

required
column string
table string
where map<string,ConditionValue>

ConditionValue

required
staticLocator string
fieldName string
values string[]

Evaluate Constraints for Quote

evaluateConstraintsForQuote

POST /policy/{tenantLocator}/quotes/{locator}/constraints/evaluate

Request Parameters:

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

Request:map<string,map<string,map<string,string>>>
Response:map<string,map<string,string[]>>
Security Group:quotes   Permission:read

Quick Quotes

Evaluate Constraints for Quick Quote

evaluateConstraintsForQuickQuote

POST /policy/{tenantLocator}/quickquotes/{locator}/constraints/evaluate

Request Parameters:

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

Request:map<string,map<string,map<string,string>>>
Response:map<string,map<string,string[]>>
Security Group:quick-quotes   Permission:read

Fetch Dependency Map for Quick Quote

fetchDependencyMapForQuickQuote

GET /policy/{tenantLocator}/quickquotes/{locator}/constraints/dependency

Request Parameters:

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

Response:map<string,map<string,ConstraintDependency>>
Security Group:quick-quotes   Permission:read

Policy Transactions

Fetch Dependency Map for Policy Transaction

fetchDependencyMapForPolicyTransaction

GET /policy/{tenantLocator}/transactions/{locator}/elements/constraints/dependency

Request Parameters:

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

Response:map<string,map<string,ConstraintDependency>>
Security Group:transactions   Permission:read

Evaluate Constraints for Policy Transaction

evaluateConstraintsForPolicyTransaction

POST /policy/{tenantLocator}/transactions/{locator}/elements/constraints/evaluate

Request Parameters:

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

Request:map<string,map<string,map<string,string>>>
Response:map<string,map<string,string[]>>
Security Group:transactions   Permission:read

Configuration

Fetch Constraints

fetchConstraints

GET /resource/{tenantLocator}/constraints/{name}/record

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required
date	query	datetime?	optional
byStaticName	query	boolean?	optional
key	query	string[]?	optional

Response:map<string,object[]>
Security Group:constraints   Permission:read

Create Constraint Table

createConstraintTable

POST /resource/{tenantLocator}/constraints

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	query	string	required
staticName	query	string	required

Request:file
Response:BasicResourceResponse
Security Group:constraints   Permission:upload

Replace Constraint Table

replaceConstraintTable

PATCH /resource/{tenantLocator}/constraints/{name}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required

Request:file
Response:BasicResourceResponse
Security Group:constraints   Permission:upload

Zip Constraint Table

zipConstraintTable

GET /resource/{tenantLocator}/constraints/{name}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required

Response:StreamingResponseBody<ZipFile>
Security Group:constraints   Permission:read