Resource Service API

Action	Endpoint
Fetch a Resource Group	GET/resource/{tenantLocator}/groups/{locator}
Fetch all Resource Groups	GET/resource/{tenantLocator}/groups/list
Create a Resource Group	POST/resource/{tenantLocator}/groups
Update a Resource Group	PATCH/resource/{tenantLocator}/groups/{locator}
Retire a ResourceGroup	PATCH/resource/{tenantLocator}/groups/{locator}/retire
Fetch a Resource	GET/resource/{tenantLocator}/resources/{name}
Fetch Multiple Resources	GET/resource/{tenantLocator}/resources/list
Fetch Multiple Resources by Type	GET/resource/{tenantLocator}/resources/type/{type}/list

Resource Groups

Fetch a Resource Group

Fetch a Resource GroupfetchResourceGroup

GET/resource/{tenantLocator}/groups/{locator}

Parameters

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

Response:ResourceGroupResponse

Security Group:resource-groups

Permission:

read

ResourceGroupResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`name`	`string`
`selectionStartTime`	`datetime`
`createdAt`	`datetime`
`createdBy`	`uuid`
`retired`	`boolean`
`resourceNames`	`string[]`

Fetch all Resource Groups

Fetch all Resource GroupsfetchResourceGroups

GET/resource/{tenantLocator}/groups/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.
`excludeRetired`	query	`boolean?`	No	Default value true.
`excludeActive`	query	`boolean?`	No	Default value false.

Response:ResourceGroupListResponse

Security Group:resource-groups

Permission:

list

ResourceGroupListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`ResourceGroupResponse[]`

Create a Resource Group

Create a Resource GroupcreateResourceGroup

POST/resource/{tenantLocator}/groups

Parameters

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

Request:ResourceGroupCreateRequest

Response:ResourceGroupResponse

Security Group:resource-groups

Permission:

write

ResourceGroupCreateRequest

Required properties

Property	Type	Description
`name`	`string`
`selectionStartTime`	`datetime`
`resourceNames`	`string[]`

Update a Resource Group

Update a Resource GroupupdateResourceGroup

PATCH/resource/{tenantLocator}/groups/{locator}

Parameters

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

Request:ResourceGroupUpdateRequest

Response:ResourceGroupResponse

Security Group:resource-groups

Permission:

write

ResourceGroupUpdateRequest

Required properties

Property	Type	Description
`name`	`string`
`selectionStartTime`	`datetime`
`addResources`	`string[]`
`removeResources`	`string[]`

Retire a ResourceGroup

Retire a ResourceGroupretire

PATCH/resource/{tenantLocator}/groups/{locator}/retire

Parameters

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

Response:ResourceGroupResponse

Security Group:resource-groups

Permission:

write

Resources

Fetch a Resource

Fetch a ResourcefetchResource

GET/resource/{tenantLocator}/resources/{name}

Parameters

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

Response:ResourceResponse

Security Group:resources

Permission:

read

ResourceResponse

Required properties

Property	Type	Description
`name`	`string`
`resourceType`	`Enum constraintTable \| customFont \| documentTemplate \| documentTemplateSnippet \| rangeTable \| secret \| staticDocument \| table`
`createdAt`	`datetime`
`createdBy`	`uuid`
`jurisdictions`	`string[]`

Optional properties

Property	Type	Description
`lookupTableLocator`	`ulid?`
`staticDocumentLocator`	`ulid?`
`staticName`	`string?`
`format`	`Enum? text \| html \| pdf \| jpg \| jpeg \| doc \| docx \| xls \| xlsx \| csv \| txt \| zip`
`rendering`	`Enum? dynamic \| prerendered`
`scope`	`Enum? transaction \| policy \| term \| segment \| invoice`
`template`	`string?`
`templateFormat`	`Enum? liquid \| velocity`
`trigger`	`Enum? validated \| priced \| accepted \| underwritten \| issued \| generated`

BasicResourceResponse

Required properties

Property	Type	Description
`name`	`string`
`resourceType`	`Enum constraintTable \| customFont \| documentTemplate \| documentTemplateSnippet \| rangeTable \| secret \| staticDocument \| table`
`createdAt`	`datetime`
`createdBy`	`uuid`
`jurisdictions`	`string[]`

Optional properties

Property	Type	Description
`constraintTableLocator`	`ulid?`
`fontLocator`	`ulid?`
`lookupTableLocator`	`ulid?`
`rangeTableLocator`	`ulid?`
`riskAssessmentCriteriaLocator`	`ulid?`
`staticDocumentLocator`	`ulid?`
`uiConfigLocator`	`ulid?`
`staticName`	`string?`
`template`	`string?`
`templateFormat`	`Enum? liquid \| velocity`

Fetch Multiple Resources

Fetch Multiple ResourcesfetchMultipleResources

GET/resource/{tenantLocator}/resources/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:ResourceListResponse

Security Group:resources

Permission:

list

Fetch Multiple Resources by Type

Fetch Multiple Resources by TypefetchMultipleResourcesByType

GET/resource/{tenantLocator}/resources/type/{type}/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`type`	path	`string`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:ResourceListResponse

Security Group:resources

Permission:

list

ResourceListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`ResourceResponse[]`

TemplateResponse

Properties

Property	Type	Description
`file`	`object?`
`template`	`string?`

Resource Service API

On this page