Skip to main content
POST
/
v3
/
equipment-models
Create a new equipment model
curl --request POST \
  --url https://api.ctrl-hub.com/v3/equipment-models \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "description": "<string>",
      "specification": {
        "vibration": {
          "magnitude": 123
        }
      },
      "documentation": [
        {
          "name": "<string>",
          "link": "<string>",
          "description": "<string>"
        }
      ]
    },
    "relationships": {
      "manufacturer": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "description": "<string>",
      "specification": {
        "vibration": {
          "magnitude": 123
        }
      },
      "documentation": [
        {
          "name": "<string>",
          "link": "<string>",
          "description": "<string>"
        }
      ]
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "manufacturer": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "categories": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "name": "<string>"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "equipment_items": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Body

application/vnd.api+json

The equipment model to create. The optional specification.vibration.magnitude is the source HAVS vibration value used by exposure calculations.

data
object
required

Response

Get an equipment model.

JSON API response object

data
object
required

An equipment model

jsonapi
object
required
included
object[]

Related resources that can be included when an equipment model is returned.

An equipment category