Resource Service API

Resource Groups

Fetch a Resource Group

fetchResourceGroup

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

Request Parameters:

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

Response:ResourceGroupResponse

Security Group:resource-groups Permission:read

ResourceGroupResponse

¶

required
locator string
name string
selectionStartTime datetime
createdAt datetime
createdBy uuid
retired boolean
resourceNames string[]

Fetch all Resource Groups

¶

fetchResourceGroups

GET /resource/{tenantLocator}/groups/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:ResourceGroupListResponse

Security Group:resource-groups Permission:list

ResourceGroupListResponse

¶

required
listCompleted boolean
items ResourceGroupResponse[]

Create a Resource Group

¶

createResourceGroup

POST /resource/{tenantLocator}/groups

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:ResourceGroupCreateRequest

Response:ResourceGroupResponse

Security Group:resource-groups Permission:write

ResourceGroupCreateRequest

¶

required
name string
selectionStartTime datetime
resourceNames string[]

Update a Resource Group

¶

updateResourceGroup

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

Request Parameters:

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

Request:ResourceGroupUpdateRequest

Response:ResourceGroupResponse

Security Group:resource-groups Permission:write

ResourceGroupUpdateRequest

¶

required
name string
selectionStartTime datetime
addResources string[]
removeResources string[]

Retire a ResourceGroup

¶

retire

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

Request Parameters:

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

Response:ResourceGroupResponse

Security Group:resource-groups Permission:write

Resources

Fetch a Resource

¶

fetchResource

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

Request Parameters:

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

Response:ResourceResponse

Security Group:resources Permission:read

ResourceResponse

¶

required
name string
resourceType Enum table | constraintTable | secret | documentTemplate | staticDocument
createdAt datetime
createdBy uuid

optional
lookupTableLocator string?
staticDocumentLocator string?
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 | issued | underwritten | generated

BasicResourceResponse

¶

required
name string
resourceType Enum table | constraintTable | secret | documentTemplate | staticDocument
createdAt datetime
createdBy uuid

optional
constraintTableLocator string?
lookupTableLocator string?
staticDocumentLocator string?
staticName string?
template string?
templateFormat Enum? liquid | velocity

Fetch Multiple Resources

¶

fetchMultipleResources

GET /resource/{tenantLocator}/resources/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:ResourceListResponse

Security Group:resources Permission:list

Fetch Multiple Resources by Type

¶

fetchMultipleResourcesByType

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
type	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:ResourceListResponse

Security Group:resources Permission:list

ResourceListResponse

¶

required
listCompleted boolean
items ResourceResponse[]

TemplateResponse

¶

optional
file file?
template string?