GET/resourceTypes
Lists every resource type in the organization with its sections, placed attributes, rate cards and
components. Use it to find resource type ids; for one type, use ResourceTypes_GetResourceType. Requires
ResourceTypeDatabase.Read.
Response
Type: GetResourceTypesResponse[]
GetResourceTypesResponse
| Field | Type | Description |
|---|
| id | uuid | |
| type | string| null | |
| name | string| null | |
| icon | string| null | |
| color | string| null | |
| label | string| null | |
| category | GetResourceTypesResponseCat | |
| isDockable | boolean | |
| isScheduled | boolean | |
| hasProvider | boolean | |
| hasPayor | boolean | |
| lineItemLabel | string| null | |
| lineItemBody | uuid[]| null | |
| trackingType | string| null | |
| defaultOwner | uuid| null | |
| sections | GetResourceTypesResponseSection[]| null | |
| defaultRateCardId | uuid| null | |
| rateCards | GetOwnedRateCardResponse[]| null | |
| components | ResourceComponentResponse[]| null | |
| defaultRuleSetIds | uuid[]| null | |
GetResourceTypesResponseCat
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| icon | string| null | |
| color | string| null | |
GetResourceTypesResponseSection
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| index | integer | |
| attributes | GetResourceTypesResponsePlacement[]| null | |
GetOwnedRateCardResponse
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| usage | GetOwnedRateCardResponseUsageInfo | |
ResourceComponentResponse
| Field | Type | Description |
|---|
| id | uuid | |
| label | string| null | |
| targetResourceTypeId | uuid | |
| targetResourceTypeName | string| null | |
| targetResourceVariantId | uuid| null | |
| targetResourceVariantName | string| null | |
| quantity | integer | |
| index | integer | |
GetResourceTypesResponsePlacement
| Field | Type | Description |
|---|
| resourceAttributeId | uuid | |
| attribute | GetResourceTypesResponsePlacedAttribute | |
| isRequired | boolean | |
| pricingRole | string| null | |
| useCases | string[]| null | |
| index | integer | |
| modifiers | GetResourceTypesResponsePropertyModifier[]| null | |
GetOwnedRateCardResponseUsageInfo
| Field | Type | Description |
|---|
| variants | integer | |
| resources | integer | |