Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

templated_configurations

Search templated configurations [System Admin]

post/app/v1/templated_configurations/search

Query parameters

tenant_idstring

Tenant ID for admin users

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_by'name' | 'display_name' | 'primary_resource_type' | 'created_at' | 'updated_at'
sort_direction'asc' | 'desc'

Sort direction

Example request

{
  "page_size": 20,
  "sort_by": "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": [
    {
      "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"
    }
  ]
}