Docs

Get Resource Type

GET /resourceTypes/{resourceTypeId}

GET/resourceTypes/{resourceTypeId}

Returns one resource type in the same shape as an item of Resources_Get. The id comes from Resources_Get.

Path Parameters

FieldTypeRequiredDescription
resourceTypeIduuidRequired

Response

FieldTypeDescription
iduuid
typestring| null
namestring| null
iconstring| null
colorstring| null
labelstring| null
trackingTypestring| null
defaultOwneruuid| null
categoryGetResourceTypesResponseCat
isDockableboolean
isScheduledboolean
hasProviderboolean
hasPayorboolean
lineItemLabelstring| null
lineItemBodyuuid[]| null
sectionsGetResourceTypesResponseSection[]| null
defaultRateCardIduuid| null
rateCardsGetOwnedRateCardResponse[]| null
componentsResourceComponentResponse[]| null
defaultRuleSetIdsuuid[]| null
orgCorrelationIduuid| null

GetResourceTypesResponseCat

FieldTypeDescription
iduuid
namestring| null
iconstring| null
colorstring| null

GetResourceTypesResponseSection

FieldTypeDescription
iduuid
namestring| null
indexinteger
attributesGetResourceTypesResponsePlacement[]| null

GetOwnedRateCardResponse

FieldTypeDescription
iduuid
namestring| null
usageGetOwnedRateCardResponseUsageInfo

ResourceComponentResponse

FieldTypeDescription
iduuid
labelstring| null
targetResourceTypeIduuid
targetResourceTypeNamestring| null
targetResourceVariantIduuid| null
targetResourceVariantNamestring| null
quantityinteger
indexinteger

GetResourceTypesResponsePlacement

FieldTypeDescription
resourceAttributeIduuid
attributeGetResourceTypesResponsePlacedAttribute
isRequiredboolean
pricingRolestring| null
useCasesstring[]| null
indexinteger
modifiersGetResourceTypesResponsePropertyModifier[]| null

GetOwnedRateCardResponseUsageInfo

FieldTypeDescription
variantsinteger
resourcesinteger
needsinteger
reservationsinteger
fulfillmentItemsinteger

GetResourceTypesResponsePlacedAttribute

FieldTypeDescription
namestring| null
responseTypestring| null
isArchivedboolean
optionsGetResourceTypesResponseResponseOption[]| null

GetResourceTypesResponsePropertyModifier

FieldTypeDescription
iduuid
valuestring| null
costTypestring| null
costAmountnumber
chargeTypestring| null
chargeAmountnumber
applicationstring| null