Equipment

Update Equipment

Update a Equipment

patch/equipment/{id}

Request

Path parameters

idstring required

The id of the relevant record

Request body

namestring

The name for this Equipment.

brandstring

The name of the brand which makes this Equipment.

modelstring

The model name of this Equipment.

serial_numberstring

The serial number of this Equipment.

type_idinteger
status_idinteger
group_idinteger nullable
group_hierarchystring

A pipe delimited group hierarchy. Ex: "Level 1|Level 2|Level 3". Where Level 1 is the parent of Level 2, and 2 is the parent of 3. Any missing nodes in the hierarchy will be created.

purchase_vendor_idinteger nullable
purchase_pricenumber

The price at which the Equipment was purchased.

purchase_datestring date

We recommend using ISO-8601 formatted dates to avoid ambiguity.

warranty_expiration_datestring date

The date on which the Equipment warranty expires.

purchase_commentsstring

Any comments about the purchase of this Equipment.

in_service_datestring date

We recommend using ISO-8601 formatted dates to avoid ambiguity.

estimated_service_lifeinteger

The estimated duration in months of the service life for this Equipment.

estimated_resale_pricenumber

The estimated resale price of this Equipment.

out_of_service_datestring date

We recommend using ISO-8601 formatted dates to avoid ambiguity.

linked_vehicle_idinteger nullable
assignee_idinteger nullable
default_imagestring uri nullable

The default image URL for this Equipment.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

Example request

{
  "purchase_date": "2023-03-14",
  "warranty_expiration_date": "2023-03-14",
  "in_service_date": "2023-03-14",
  "out_of_service_date": "2023-03-14"
}

Response

OK

idinteger required
created_atstring date-time required

The date and time at which this record was created.

updated_atstring date-time required

The date and time at which this record was most recently updated.

namestring required

The name for this Equipment.

brandstring nullable required

The name of the brand which makes this Equipment.

modelstring nullable required

The model name of this Equipment.

serial_numberstring nullable required

The serial number of this Equipment.

equipment_type_idinteger required
type_namestring required

The name of the associated Equipment Type.

equipment_status_idinteger required
status_namestring required

The name of the associated Equipment Status.

group_idinteger nullable required
group_namestring nullable required

The name of the associated Group.

purchase_vendor_idinteger nullable required
purchase_price_centsinteger nullable required

The purchase price in cents.

purchase_datestring date nullable required

The date on which the Equipment was purchased.

estimated_resale_pricenumber float nullable required

The estimated resale price of this Equipment.

warranty_expiration_datestring date nullable required

The date on which the Equipment warranty expires.

purchase_commentsstring nullable required

Any comments about the purchase of this Equipment.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

in_service_datestring date nullable required

The date on which the Equipment was put into service.

estimated_service_lifeinteger nullable required

The estimated duration in months of the service life for this Equipment.

out_of_service_datestring date nullable required

The estimated date on which the Equipment will be retired from service.

archived_atstring date-time nullable required

The date and time at which the Equipment was archived.

status_colorstring nullable required

The color of the associated Equipment Status.

default_image_urlstring nullable required

The URL of the Equipment's default image/profile photo, if any.

assetable_typestring nullable required

The type of assetable object.

issues_countinteger required

The number of Issues associated with this Equipment.

comments_countinteger required

The number of Comments associated with this Equipment.

documents_countinteger required

The number of documents associated with this Equipment.

images_countinteger required

The number of images associated with this Equipment.

is_watchedboolean required

Indicates whether this Equipment is being watched.

watchers_countinteger required

The number of users watching this Equipment.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "purchase_date": "2023-03-14",
  "warranty_expiration_date": "2023-03-14",
  "in_service_date": "2023-03-14",
  "out_of_service_date": "2023-03-14",
  "linked_vehicle": {
    "archived_at": "2023-03-14T13:46:27-06:00",
    "labels": [
      {
        "color": "#44DB38"
      }
    ],
    "in_service_date": "2023-03-14T13:46:27-06:00",
    "out_of_service_date": "2023-03-14T13:46:27-06:00",
    "current_meter_date": "2023-03-14T13:46:27-06:00",
    "secondary_meter_date": "2023-03-14T13:46:27-06:00",
    "loan_ended_at": "2023-03-14T13:46:27-06:00",
    "loan_started_at": "2023-03-14T13:46:27-06:00"
  },
  "assigned_contact": {
    "group_hierarchy": "Group 1|Group 2|Group 3",
    "birth_date": "2023-03-14",
    "street_address": "123 Main St",
    "street_address_line_2": "Apt 1",
    "license_expiration": "2023-03-14"
  }
}

Changes

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