sam|nord Developers
samnord.com
Equipment

POST /equipment

Create equipment. Requires equipment.create permission.

Query parameters

Name Type Required Description
fields[] string[] no Select which fields to include in the response. When omitted, all fields are returned. When provided, only the specified fields are included. (e.g., ?fields[]=id&fields[]=name) One of: createdAt, description, equipmentGroupId, id, manufacturerId, model, name, serialNumber, siteId, status, updatedAt.
with[] string[] no Include related resources in the response. Pass multiple values as separate query parameters (e.g., ?with[]=createdBy&with[]=updatedBy). One of: createdBy, updatedBy, equipmentGroup, manufacturer, site.

Request body

Required.

application/json

  • description string
  • equipmentGroupId string (uuid)
  • manufacturerId string (uuid)
  • model string
  • name string · required
  • serialNumber string
  • siteId string (uuid)
  • status string · required
{
    "description": "Main warehouse forklift",
    "equipmentGroupId": "01932c4a-0b5e-7890-abcd-ef1234567890",
    "manufacturerId": "01932c4a-0b5e-7890-abcd-ef1234567890",
    "model": "Toyota 8FBE20",
    "name": "Forklift A-123",
    "serialNumber": "SN-98765",
    "siteId": "01932c4a-0b5e-7890-abcd-ef1234567890",
    "status": "operational"
}

Responses

Status Description
201 A json object describing the newly created equipment
400 The request was rejected
403 The requesting user lacks appropriate permissions
422 Validation errors

Response 201 body

  • id string
  • createdAt string — When the record was created (UTC)
  • createdBy object
  • description string
  • equipmentGroup object
  • equipmentGroupId string
  • manufacturer object
  • manufacturerId string
  • model string
  • name string
  • serialNumber string
  • site object
  • siteId string
  • status string
  • updatedAt string — When the record was last updated (UTC)
  • updatedBy object
{
    "id": "019222d4-1d93-7d47-a3c4-b547e009a0f7",
    "createdAt": "2024-06-30T19:00:00Z",
    "createdBy": {
        "id": "019222d9-d87d-7724-bba6-ba91503ea311",
        "firstName": "John",
        "lastName": "Doe"
    },
    "description": "Main warehouse forklift",
    "equipmentGroup": {
        "id": "019222d9-d87d-7724-bba6-ba91503ea311",
        "name": "Forklifts"
    },
    "equipmentGroupId": "019222d4-1d93-7d47-a3c4-b547e009a0f7",
    "manufacturer": {
        "id": "019222d9-d87d-7724-bba6-ba91503ea311",
        "name": "Toyota"
    },
    "manufacturerId": "019222d4-1d93-7d47-a3c4-b547e009a0f7",
    "model": "Toyota 8FBE20",
    "name": "Forklift A-123",
    "serialNumber": "SN-98765",
    "site": {
        "id": "019222d9-d87d-7724-bba6-ba91503ea311",
        "name": "Stockholm Office"
    },
    "siteId": "019222d4-1d93-7d47-a3c4-b547e009a0f7",
    "status": "operational",
    "updatedAt": "2024-06-30T19:00:00Z",
    "updatedBy": {
        "id": "019222d9-d87d-7724-bba6-ba91503ea311",
        "firstName": "John",
        "lastName": "Doe"
    }
}