Skip to main content

Create Equipment

Creates a new Equipment

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.

  • documents_attributes object[]

    An array of one or more document objects to add to the record. You may provide your own file_url, or follow our Attaching Documents and Images guide to upload to our third party storage provider.

  • name string

    Possible values: <= 255 characters

    The name to give the file which will be shown in the UI.

  • file_url string

    Possible values: <= 255 characters

    The URL pointing to the file.

  • file_mime_type string

    Possible values: <= 255 characters

    The MIME type of the file. For example, application/pdf.

  • file_name string

    Possible values: <= 255 characters

    The name of the file.

  • file_size integer

    The size of the file in bytes.

  • images_attributes object[]

    An array of one or more image objects to add to the record. You may provide your own file_url, or follow our Attaching Documents and Images guide to upload to our third party storage provider.

  • name string

    Possible values: <= 255 characters

    The name to give the image which will be shown in the UI.

  • file_url string

    Possible values: <= 255 characters

    The URL pointing to the image.

  • file_mime_type string

    Possible values: <= 255 characters

    The MIME type of the image. For example, image/png.

  • file_name string

    Possible values: <= 255 characters

    The name of the image.

  • file_size integer

    The size of the image file in bytes.

Responses

OK

Response Headers

    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.

    Loading...