Resource Service API

Resource Groups

Fetch a Resource Group
fetchResourceGroup
GET /resource/{tenantLocator}/groups/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:resource-groups   Permission:read
ResourceGroupResponse
required
locator locator
name string
selectionStartTime datetime
createdAt datetime
createdBy uuid
retired boolean
resourceNames string[]
Fetch all Resource Groups
fetchResourceGroups
GET /resource/{tenantLocator}/groups/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:resource-groups   Permission:list
ResourceGroupListResponse
required
listCompleted boolean
Create a Resource Group
createResourceGroup
POST /resource/{tenantLocator}/groups
ResourceGroupCreateRequest
required
name string
selectionStartTime datetime
resourceNames string[]
Update a Resource Group
updateResourceGroup
PATCH /resource/{tenantLocator}/groups/{locator}
ResourceGroupUpdateRequest
required
name string
selectionStartTime datetime
addResources string[]
removeResources string[]
Retire a ResourceGroup
retire
PATCH /resource/{tenantLocator}/groups/{locator}/retire
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:resource-groups   Permission:write

Resources

Fetch a Resource
fetchResource
GET /resource/{tenantLocator}/resources/{name}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    namepathstringrequired
    byStaticNamequeryboolean?optional
    datequerydatetime?optional
    Security Group:resources   Permission:read
ResourceResponse
required
name string
resourceType Enum table | constraintTable | secret | documentTemplate | staticDocument
createdAt datetime
createdBy uuid

optional
lookupTableLocator locator?
staticDocumentLocator locator?
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 locator?
lookupTableLocator locator?
staticDocumentLocator locator?
staticName string?
template string?
templateFormat Enum? liquid | velocity
Fetch Multiple Resources
fetchMultipleResources
GET /resource/{tenantLocator}/resources/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:resources   Permission:list
Fetch Multiple Resources by Type
fetchMultipleResourcesByType
GET /resource/{tenantLocator}/resources/type/{type}/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    typepathstringrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:resources   Permission:list
ResourceListResponse
required
listCompleted boolean
TemplateResponse
optional
file file?
template string?