Skip to main content

Close an Issue

Closes an Issue.

info

The Issue must be in a state that can transition to Closed status.

Managing Issues

Path Parameters

  • id string required

    Possible values: Value must match regular expression ^[0-9]+$

    The id of the relevant record

Request Body

  • note string required

    A note to add to the Issue when it is closed.

Responses

OK

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