Configurable Attributes

Configurable attributes that are scoped to an asset/entity type. These attributes can be modelled using any number and combination of data types including but not limited to string, number, integer, pick-list, date and date-time.

https://api.validere.io/app

Search custom attribute definitions for given entity type

List Custom Attribute Definitions

get

Path parameters

entity_typestring · enumRequired

Supported attribute type for custom attribute

Example: equipmentPossible values:

Query parameters

page_sizenumberOptional

page size

pagenumberOptional

page number

sort_byundefined · enumOptional

sort by

Possible values:

sort_directionstring · enumOptional

sort direction

Example: descPossible values:

field_namestringOptional

String to search for in field names

entity_subtypestringOptional

String to search for in entity subtype

archivedbooleanOptional

Set true to return archived attribute definitions

Responses

200

successful operation

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /app/v1/custom_attribute_definition/{entity_type} HTTP/1.1
Host: api.validere.io
Accept: */*

200

successful operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "archived": true,
      "company_id": "text",
      "data_type": "number",
      "description": "text",
      "display_name": "text",
      "entity_type": "equipment",
      "entity_subtypes": [
        "text"
      ],
      "field_name": "text",
      "is_required": true,
      "lookup_entity_type": "equipment",
      "pick_list_values": [
        "text"
      ],
      "unit": "text"
    }
  ]
}

Get available custom attribute data types

List Custom Attribute Data Types

get

Returns the list of data types that custom attributes support

Responses

200

successful operation

application/json

get

HTTPcURLJavaScriptPython

GET /app/v1/custom_attribute_data_types HTTP/1.1
Host: api.validere.io
Accept: */*

200

successful operation

[
  {
    "id": "number",
    "name": "text"
  }
]

Get available entities

Entities available to configure/scope custom attribute configurations

List Custom Attribute Entity Types

get

Returns the list of entity types that support custom attributes

Responses

200

successful operation

application/json

get

HTTPcURLJavaScriptPython

GET /app/v1/custom_attribute_entities HTTP/1.1
Host: api.validere.io
Accept: */*

200

successful operation

[
  {
    "id": "equipment",
    "name": "text"
  }
]