Create Equipment
Creates a new Equipment
- application/json
Request Body
- name string required
The name for this Equipment.
- brand string
The name of the brand which makes this Equipment.
- model string
The model name of this Equipment.
- serial_number string
The serial number of this Equipment.
- type_id integer required
Possible values:
>= 1
- status_id integer required
Possible values:
>= 1
- group_id NullableId
Possible values:
>= 1
- group_hierarchy string
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_id NullableId
Possible values:
>= 1
- purchase_price number
The price at which the Equipment was purchased.
- purchase_date date
We recommend using ISO-8601 formatted dates to avoid ambiguity.
- warranty_expiration_date date
The date on which the Equipment warranty expires.
- purchase_comments string
Any comments about the purchase of this Equipment.
- in_service_date date
We recommend using ISO-8601 formatted dates to avoid ambiguity.
- estimated_service_life integer
The estimated duration in months of the service life for this Equipment.
- estimated_resale_price number
The estimated resale price of this Equipment.
- out_of_service_date date
We recommend using ISO-8601 formatted dates to avoid ambiguity.
- linked_vehicle_id NullableId
Possible values:
>= 1
- assignee_id NullableId
Possible values:
>= 1
- default_image uri
The default image URL for this Equipment.
- custom_fields object
*Full details on working with Custom Fields here.
- 201
- 401
- 403
- 422
- 500
OK
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
- id integer
Possible values:
>= 1
- created_at date-time
The date and time at which this record was created.
- updated_at date-time
The date and time at which this record was most recently updated.
- account_id integer
The ID of the
Account
this Equipment belongs to. - name string
The name for this Equipment.
- brand string
The name of the brand which makes this Equipment.
- model string
The model name of this Equipment.
- serial_number string
The serial number of this Equipment.
- equipment_type_id integer
Possible values:
>= 1
- equipment_status_id integer
Possible values:
>= 1
- group_id NullableId
Possible values:
>= 1
- purchase_vendor_id NullableId
Possible values:
>= 1
- purchase_price_cents number
The purchase price in cents.
- purchase_date date
The date on which the Equipment was purchased.
- warranty_expiration_date date
The date on which the Equipment warranty expires.
- purchase_comments string
Any comments about the purchase of this Equipment.
- custom_fields object
*Full details on working with Custom Fields here.
- in_service_date date
The date on which the Equipment was put into service.
- estimated_service_life integer
The estimated duration in months of the service life for this Equipment.
- out_of_service_date date
The estimated date on which the Equipment will be retired from service.
- archived_at date-time
The date and time at which the Equipment was archived.
- current_location_entry_id NullableId
Possible values:
>= 1
- watchers_count integer
The number of users watching this Equipment.
- watchable_options object
- bulk_watch_record boolean
Whether or not to bulk watch this Equipment.
- estimated_resale_price_cents integer
The estimated resale price of this Equipment.
- label_list string[]
A list of any labels applied to this Equipment.
- skip_automatic_watchers_callbacks boolean
Whether or not to skip automatic watchers callbacks on this Equipment.
- comments_count integer
The number of
Comments
on this Equipment. - documents_count integer
The number of documents attached to this Equipment.
- images_count integer
The number of images attached to this Equipment.
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"account_id": 0,
"name": "string",
"brand": "string",
"model": "string",
"serial_number": "string",
"equipment_type_id": 0,
"equipment_status_id": 0,
"group_id": 0,
"purchase_vendor_id": 0,
"purchase_price_cents": 0,
"purchase_date": "2023-03-14",
"warranty_expiration_date": "2023-03-14",
"purchase_comments": "string",
"custom_fields": {},
"in_service_date": "2023-03-14",
"estimated_service_life": 0,
"out_of_service_date": "2023-03-14",
"archived_at": "2024-10-02",
"current_location_entry_id": 0,
"watchers_count": 0,
"watchable_options": {},
"bulk_watch_record": true,
"estimated_resale_price_cents": 0,
"label_list": [
"string"
],
"skip_automatic_watchers_callbacks": true,
"comments_count": 0,
"documents_count": 0,
"images_count": 0
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Insufficient permission to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Unprocessable Entity
- application/json
- Schema
- Example (from schema)
- Example
Schema
errors object
typeitems string
{
"errors": {}
}
{
"errors": {
"field1": [
"error1",
"error2"
],
"field2": [
"error3"
]
}
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}