Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

templated_configurations

Get a templated configuration

get/app/v1/templated_configurations/{templated_configuration_name}

Path parameters

templated_configuration_namestring required

Templated Configuration Name

Query parameters

tenant_idstring

Tenant ID for admin users

Response

successful operation

namestring required
display_namestring required
primary_resource_type'equipment' | 'flow' | 'asset_group' | 'asset_group_asset' | 'form_submission' | 'default_record_value_configuration' | 'estimation_method' | 'default_calculator_input_record' | 'reporting_group_estimation_method' | 'reporting_group' required
other_resource_typesstring[] required
created_atstring date-time required
updated_atstring date-time required
descriptionstring required

Example response

{
  "name": "CompressorTemplate",
  "display_name": "Compressor Template",
  "description": "Compressor Template Description",
  "primary_resource_type": "equipment",
  "other_resource_types": [
    "flow"
  ],
  "equipment_types": [
    {
      "id": "cal_revamp_desiccant_dehydrator",
      "name": "Desiccant Dehydrator"
    },
    {
      "id": "cal_revamp_dehydrator",
      "name": "Dehydrator"
    }
  ],
  "configuration": {
    "custom_attribute_configuration": {
      "equipment1": {
        "entity_type": "equipment",
        "entity_subtypes": [
          "cal_revamp_desiccant_dehydrator",
          "cal_revamp_compressor"
        ]
      },
      "flow1": {
        "entity_type": "flow",
        "entity_subtypes": []
      }
    }
  },
  "created_at": "2021-08-01T00:00:00Z",
  "updated_at": "2021-08-01T00:00:00Z"
}