Skip to main content

Create Issue

Creates a new Issue

Request Body

  • asset_id integer required

    The ID of the asset associated with the Issue.

  • asset_type string required

    Possible values: [Vehicle, Equipment]

    The type of the asset associated with the Issue.

  • summary string required

    A short summary of the Issue.

  • description string

    A longer description of the Issue.

  • reported_by_id integer

    The id of the Contact who reported this Issue.

  • reported_at date-time required

    The date and time this Issue is reported. We recommend using ISO-8601 formatted dates to avoid ambiguity.

  • issue_priority_id integer

    The id of the associated IssuePriority for this Issue.

  • number integer

    A unique identifier for the Issue.

  • due_date date-time

    The date on which this Issue should be resolved by. We recommend using ISO-8601 formatted dates to avoid ambiguity.

  • due_meter_value float

    The meter value at which this Issue should be resolved by.

  • due_secondary_meter_value float

    The secondary meter value at which this Issue should be resolved by.

  • fault_id integer

    The id of the Fault associated with this Issue.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • meter_entry_attributes object

    An Issue may be associated with a Meter Entry.

  • value float

    The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.

  • void boolean

    If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.

  • secondary_meter_entry_attributes object

    An Issue may be associated with a secondary Meter Entry.

  • value float

    The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.

  • void boolean

    If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.

  • comments_attributes object[]
  • title string

    The title of the comment.

  • comment string

    The comment text.

  • 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.

  • assigned_contact_ids integer[]

    An array of ids of assigned Contacts related to the Issue.

  • label_ids integer[]
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.

    • number integer

      Possible values: >= 1

      A unique identifier for the Issue.

    • summary string

      A summary of the Issue.

    • description string

      A longer description of the Issue.

    • state string

      Possible values: [open, closed, resolved]

      The Issue's current state.

    • reported_at date-time

      The date and time at which this Issue was reported.

    • reported_by object

      The Contact ID of the User who reported this Issue.

    • id integer

      Possible values: >= 1

    • resolvable_type string

      Possible values: [ServiceEntry, WorkOrder]

      The type of the object which can resolve this Issue.

    • resolved_at date-time

      The date and time at which this Issue was resolved.

    • resolved_by object

      The Contact ID of the User that resolved this Issue.

    • id integer

      Possible values: >= 1

    • resolved_note string

      Any notes associated with resolving this Issue.

    • closed_at date-time

      The date and time at which this Issue was closed.

    • closed_by object

      The Contact ID of the User that closed this Issue.

    • id integer

      Possible values: >= 1

    • closed_note string

      Any notes associated with closing this Issue.

    • due_date date

      The date on which this Issue should be resolved by. Formatted according to ISO-8601 in User's local time zone.

    • due_meter_value float

      The meter value at which this Issue should be resolved by.

    • due_secondary_meter_value float

      The secondary meter value at which this Issue should be resolved by.

    • is_overdue boolean

      Indicates whether the Issue is overdue.

    • issue_priority object

      An Issue Priority represents the priority level of an Issue.

    • 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

      Possible values: >= 1

    • alias string

      Can be used to replace the default priority name provided. Changes how the Issue is displayed throughout Fleetio.

    • name string

      The name of the Issue Priority.

    • slug string

      Indicates which icon will be shown for the Issue Priority.

    • description string

      A description providing more details about the Issue Priority.

    • default boolean

      Indicates whether this Issue Priority will be set as default for new Issues.

    • enabled boolean

      Indicates whether this Issue Priority is currently enabled.

    • position integer

      The position or order of the Issue Priority in a list or hierarchy.

    • resolvable object

      The ID of the object which can resolve this Issue.

    • id integer

      Possible values: >= 1

    • creation_type string

      Possible values: [manual, workflow]

      Indicates if this Issue was created manually or by a workflow.

    • attachment_permissions object
    • read_photos boolean

      Indicates whether the user has read permission for photos.

    • manage_photos boolean

      Indicates whether the user has permission to manage (eg. upload, delete) photos.

    • read_documents boolean

      Indicates whether the user has read permission for documents.

    • manage_documents boolean

      Indicates whether the user has permission to manage (eg. upload, delete) documents.

    • asset object
    • id integer

      Possible values: >= 1

    • name string

      The name of the asset associated with the Issue.

    • image_url_medium string

      The URL to a medium-sized image of the asset associated with the Issue.

    • asset_type string

      Possible values: [Vehicle, Equipment]

      The asset type that has the Issue.

    • submitted_inspection_form object
    • id integer

      Possible values: >= 1

    • fault object
    • id integer

      Possible values: >= 1

    • watchers_count integer

      The count of watchers associated with the Issue.

    • comments_count integer

      The count of Comments associated with the Issue.

    • images_count integer

      The count of images associated with the Issue.

    • documents_count integer

      The count of documents associated with the Issue.

    • custom_fields object

      *Full details on working with Custom Fields here.

    • labels object[]

      An array of labels associated with the Issue. Can be included in the response by passing labels in the includes query parameter.

    • id integer

      Possible values: >= 1

    • name string

      The name of the label.

    • color string

      The color of the label.

    Loading...