Resource Service API
Resource Groups
GET /resource/{tenantLocator}/groups/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:ResourceGroupResponse
Security Group:resource-groups  Permission:read
ResourceGroupResponse
¶requiredlocator locatorname stringselectionStartTime datetimecreatedAt datetimecreatedBy uuidretired booleanresourceNames string[]
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
¶requiredlistCompleted booleanitems ResourceGroupResponse[]
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
¶requiredname stringselectionStartTime datetimeresourceNames string[]
PATCH /resource/{tenantLocator}/groups/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:ResourceGroupUpdateRequest
Response:ResourceGroupResponse
Security Group:resource-groups  Permission:write
ResourceGroupUpdateRequest
¶requiredname stringselectionStartTime datetimeaddResources string[]removeResources string[]
PATCH /resource/{tenantLocator}/groups/{locator}/retire
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:ResourceGroupResponse
Security Group:resource-groups  Permission:write
Resources
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
¶requiredname stringresourceType Enum table | constraintTable | secret | documentTemplate | staticDocumentcreatedAt datetimecreatedBy uuidoptionallookupTableLocator locator?staticDocumentLocator locator?staticName string?format Enum? text | html | pdf | jpg | jpeg | doc | docx | xls | xlsx | csv | txt | ziprendering Enum? dynamic | prerenderedscope Enum? transaction | policy | term | segment | invoicetemplate string?templateFormat Enum? liquid | velocitytrigger Enum? validated | priced | accepted | issued | underwritten | generated
BasicResourceResponse
¶requiredname stringresourceType Enum table | constraintTable | secret | documentTemplate | staticDocumentcreatedAt datetimecreatedBy uuidoptionalconstraintTableLocator locator?lookupTableLocator locator?staticDocumentLocator locator?staticName string?template string?templateFormat Enum? liquid | velocity
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
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
¶requiredlistCompleted booleanitems ResourceResponse[]
TemplateResponse
¶optionalfile file?template string?