Elements

Create an Element (Asset)

Creates a new of Element, which represent the Assets managed in Infraspeak.

This operation requires associating the new Element with a Category, Location, and Maintenance Policy via their respective IDs in the request body.

Please refer to the Request Body schema definition below for detailed descriptions of all fields, specific validation rules (e.g., allowed types for category_id and local_id), mandatory fields (required), constraints, and examples.

post/elements

Request

  • Base URL: https://api.infraspeak.com/v3
  • URL: https://api.infraspeak.com/v3/elements
  • Auth: HTTP bearer

Request body

nfc_codeunknown
bar_codeunknown
latitudeunknown
longitudeunknown
observationunknown
codeunknown
category_idinteger required

Mandatory ID of the associated Category.

  • Must reference a Category from GET /categories/all.
  • The Category must be of type "TYPE_OF_EQUIPMENT". Categories of type "SOFT_MAINTENANCE" are NOT allowed.
local_idinteger required

Mandatory ID of the associated Location (where the Element is situated).

  • Must reference a Location from GET /locations.
  • The Location must be of type "location". Locations of type "building" or "location-folder" are NOT allowed.
maintenance_policy_idinteger required

Mandatory ID of the associated Maintenance Policy.

  • Must reference a Maintenance Policy from GET /maintenance-policies.
  • The Maintenance Policy must belong to the same Category specified in category_id.
acquisition_costunknown
acquisition_datestring date-time

Optional date (and time) when the Element was acquired (or put into service). Uses ISO 8601 date-time format.

supplier_nameunknown
lifetimeunknown
residual_valueunknown
stoppage_costunknown
element_uuidunknown

Response

OK

Example response

{
  "included": [
    {
      "id": "1",
      "attributes": {
        "element_health_score_info": 1,
        "health_score_flag": 1,
        "health_score": 0.85
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.