Tables API

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

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}
Fetch a Range Table Record	GET/resource/{tenantLocator}/rangeTables/{name}/record
Fetch a Range Table in ZIP Format	GET/resource/{tenantLocator}/rangeTables/{name}
Create a Range Table	POST/resource/{tenantLocator}/rangeTables
Replace a Range Table	PATCH/resource/{tenantLocator}/rangeTables/{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

Fetch a Table RecordfetchTableRecord

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes
`date`	query	`datetime?`	No
`jurisdiction`	query	`string?`	No
`byStaticName`	query	`boolean?`	No
`key`	query	`string[]`	Yes

Response:TableLookupResponse

Security Group:tables

Permission:

read

TableLookupResponse

Required properties

Property	Type	Description
`value`	`object`

Configuration

Fetch a Lookup Table in ZIP Format

Fetch a Lookup Table in ZIP FormatfetchLookupTableInZipFormat

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes

Response:StreamingResponseBody<ZipFile>

Security Group:tables

Permission:

read

Create a Lookup Table

Create a Lookup TablecreateLookupTable

POST/resource/{tenantLocator}/tables

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes
`staticName`	query	`string`	Yes
`jurisdiction`	query	`string[]?`	No

Request:file

Response:BasicResourceResponse

Security Group:tables

Permission:

upload

Files must be converted to ZIP files before uploading.

Replace a Lookup Table

Replace a Lookup TablereplaceLookupTable

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes

Request:file

Response:BasicResourceResponse

Security Group:tables

Permission:

upload

Files must be converted to ZIP files before uploading.

Range Tables

Usage

Fetch a Range Table Record

Fetch a Range Table RecordfetchRangeTableRecord

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes
`date`	query	`datetime?`	No
`jurisdiction`	query	`string?`	No
`byStaticName`	query	`boolean?`	No
`key`	query	`string[]`	Yes
`boundValue`	query	`number`	Yes

Response:TableLookupResponse

Security Group:tables

Permission:

read

Configuration

Fetch a Range Table in ZIP Format

Fetch a Range Table in ZIP FormatfetchRangeTableInZipFormat

GET/resource/{tenantLocator}/rangeTables/{name}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes

Response:StreamingResponseBody<ZipFile>

Security Group:tables

Permission:

read

Create a Range Table

Create a Range TablecreateRangeTable

POST/resource/{tenantLocator}/rangeTables

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes
`staticName`	query	`string`	Yes
`jurisdiction`	query	`string[]?`	No

Request:file

Response:BasicResourceResponse

Security Group:tables

Permission:

upload

Files must be converted to ZIP files before uploading.

Replace a Range Table

Replace a Range TablereplaceRangeTable

PATCH/resource/{tenantLocator}/rangeTables/{name}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes

Request:file

Response:BasicResourceResponse

Security Group:tables

Permission:

upload

Files must be converted to ZIP files before uploading.

Constraint Tables

Accounts

Evaluate Constraints For Account

Evaluate Constraints For AccountevaluateConstraintsForAccount

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

Parameters

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

Request:map<string, map<string, string>>

Response:map<string, map<string, string[]>>

Security Group:accounts

Permission:

read

Fetch Dependency Map For Account

Fetch Dependency Map For AccountfetchDependencyMapForAccount

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

Parameters

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

Response:map<string, map<string, ConstraintDependency>>

Security Group:accounts

Permission:

read

Quotes

Fetch Dependency Map For Quote

Fetch Dependency Map For QuotefetchDependencyMapForQuote

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

Parameters

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

Response:map<string, map<string, ConstraintDependency>>

Security Group:quotes

Permission:

read

ConstraintDependency

Required properties

Property	Type	Description
`column`	`string`
`table`	`string`
`where`	`map<string, ConditionValue>`

ConditionValue

Required properties

Property	Type	Description
`staticLocator`	`ulid`
`fieldName`	`string`
`values`	`string[]`

Evaluate Constraints For Quote

Evaluate Constraints For QuoteevaluateConstraintsForQuote

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

Parameters

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

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

Evaluate Constraints For Quick QuoteevaluateConstraintsForQuickQuote

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

Parameters

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

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

Fetch Dependency Map For Quick QuotefetchDependencyMapForQuickQuote

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

Parameters

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

Response:map<string, map<string, ConstraintDependency>>

Security Group:quick-quotes

Permission:

read

Policy Transactions

Fetch Dependency Map For Policy Transaction

Fetch Dependency Map For Policy TransactionfetchDependencyMapForPolicyTransaction

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

Parameters

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

Response:map<string, map<string, ConstraintDependency>>

Security Group:transactions

Permission:

read

Evaluate Constraints For Policy Transaction

Evaluate Constraints For Policy TransactionevaluateConstraintsForPolicyTransaction

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

Parameters

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

Request:map<string, map<string, map<string, string>>>

Response:map<string, map<string, string[]>>

Security Group:transactions

Permission:

read

Configuration

Fetch Constraints

Fetch ConstraintsfetchConstraints

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes
`date`	query	`datetime?`	No
`jurisdiction`	query	`string?`	No
`byStaticName`	query	`boolean?`	No
`key`	query	`string[]?`	No

Response:map<string, object[]>

Security Group:constraints

Permission:

read

Create Constraint Table

Create Constraint TablecreateConstraintTable

POST/resource/{tenantLocator}/constraints

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`name`	query	`string`	Yes
`staticName`	query	`string`	Yes
`jurisdiction`	query	`string[]?`	No

Request:file

Response:BasicResourceResponse

Security Group:constraints

Permission:

upload

Files must be converted to ZIP files before uploading.

Replace Constraint Table

Replace Constraint TablereplaceConstraintTable

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes

Request:file

Response:BasicResourceResponse

Security Group:constraints

Permission:

upload

Files must be converted to ZIP files before uploading.

Zip Constraint Table

Zip Constraint TablezipConstraintTable

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`name`	path	`string`	Yes

Response:StreamingResponseBody<ZipFile>

Security Group:constraints

Permission:

read

Tables API

On this page