Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

templated_configurations

Create a templated configuration run

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

Path parameters

templated_configuration_namestring required

Templated Configuration Name

Request body

inputsobject

Dictionary of input values for the template

custom_attribute_inputsobject

Dictionary of custom attributes for template assets, keys are the template resource ID

custom_attribute_configurationCustomAttributeConfigurationInput

Example request

{
  "inputs": {
    "equipment_name": "My Dehydrator",
    "facility_id": "96d868a3-6eab-4955-8782-bb055f5deafd"
  },
  "custom_attribute_inputs": {
    "equipment1": {
      "equipment_ca1": "string"
    },
    "flow1": {
      "flow_ca1": "string"
    }
  },
  "custom_attribute_configuration": {
    "equipment1": {
      "entity_subtype": "compressor"
    }
  }
}

Response

successful operation

idstring uuid
templated_configuration_namestring
company_idstring uuid
status'submitted' | 'partial' | 'success' | 'failed'
resultobject
created_bystring uuid
created_atstring date-time
updated_bystring uuid
updated_atstring date-time
inputsobject

Dictionary of input values for the template

custom_attribute_inputsobject

Dictionary of custom attributes for template assets, keys are the template resource ID

custom_attribute_configurationCustomAttributeConfigurationInput

Example response

{
  "resources": [
    {
      "template_resource_id": "equipment1",
      "name": "Equipment 1",
      "errors": {
        "message": "Failed to create equipment",
        "detail": "Extra error details"
      },
      "metadata": {
        "facility_name": "My Facility",
        "facility_id": "96d868a3-6eab-4955-8782-bb055f5deafd",
        "dependencies": [
          "equipment1",
          "flow1"
        ]
      }
    }
  ],
  "primary_resource": {
    "template_resource_id": "equipment1",
    "name": "Equipment 1",
    "errors": {
      "message": "Failed to create equipment",
      "detail": "Extra error details"
    },
    "metadata": {
      "facility_name": "My Facility",
      "facility_id": "96d868a3-6eab-4955-8782-bb055f5deafd",
      "dependencies": [
        "equipment1",
        "flow1"
      ]
    }
  },
  "inputs": {
    "equipment_name": "My Dehydrator",
    "facility_id": "96d868a3-6eab-4955-8782-bb055f5deafd"
  },
  "custom_attribute_inputs": {
    "equipment1": {
      "equipment_ca1": "string"
    },
    "flow1": {
      "flow_ca1": "string"
    }
  },
  "custom_attribute_configuration": {
    "equipment1": {
      "entity_subtype": "compressor"
    }
  }
}