Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

templated_configurations

Search templated configuration runs

post/app/v1/templated_configurations/runs/search

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_by'id' | 'templated_configuration_name' | 'status' | 'created_at' | 'created_by' | 'updated_at' | 'primary_resource.status' | 'primary_resource.type' | 'primary_resource.name' | 'primary_resource.metadata.facility_name' | 'primary_resource.metadata.sub_type'
sort_direction'asc' | 'desc'

Sort direction

Example request

{
  "page_size": 20,
  "sort_by": "templated_configuration_name",
  "sort_direction": "desc"
}

Response

successful operation

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "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"
        }
      }
    }
  ]
}