Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

templated_configurations

Generate an input schema for a templated configuration, enriched with entity subtype specific custom attributes if applicable.

post/app/v1/templated_configurations/{templated_configuration_name}/input_schema

Path parameters

templated_configuration_namestring required

Templated Configuration Name

Request body

custom_attribute_configurationobject required

Example request

{
  "custom_attribute_configuration": {
    "equipment1": {
      "entity_subtype": "compressor"
    }
  }
}

Response

successful operation

inputsobject required
custom_attribute_inputsobject required

Example response

{
  "inputs": {
    "equipment_name": {
      "display_name": "Equipment Name",
      "description": "The name of the equipment",
      "data_type": "string",
      "is_required": true
    },
    "facility_id": {
      "display_name": "ID of Facility",
      "description": "The id of the facility",
      "data_type": "string",
      "is_required": true
    }
  },
  "custom_attribute_inputs": {
    "equipment1": {
      "equipment_ca1": {
        "company_id": "11cb1b81-bcc1-4663-a58d-4b6a637a98f5",
        "data_type": "string",
        "field_name": "equipment_ca1",
        "description": "This is a custom attribute",
        "entity_type": "equipment",
        "entity_subtypes": [
          "cal_revamp_compressor"
        ],
        "display_name": "My Custom Attribute",
        "archived": false,
        "is_required": true
      }
    },
    "flow1": {
      "flow_ca1": {
        "company_id": "11cb1b81-bcc1-4663-a58d-4b6a637a98f5",
        "data_type": "string",
        "field_name": "flow_ca1",
        "description": "This is a custom attribute",
        "entity_type": "flow",
        "display_name": "My Custom Attribute",
        "archived": false,
        "is_required": true
      }
    }
  }
}