Issues

Update Issue

Update an Issue

patch/issues/{id}

Request

Path parameters

idstring required

The id of the relevant record

Request body

asset_idinteger

The ID of the asset associated with the Issue.

asset_type'Vehicle' | 'Equipment'

The type of the asset associated with the Issue.

summarystring

A short summary of the Issue.

descriptionstring

A longer description of the Issue.

reported_by_idinteger

The id of the Contact who reported this Issue.

reported_atstring date-time

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

issue_priority_idinteger

The id of the associated IssuePriority for this Issue.

numberinteger

A unique identifier for the Issue.

due_datestring date-time

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

due_meter_valuenumber float

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

due_secondary_meter_valuenumber float

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

fault_idinteger

The id of the Fault associated with this Issue.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

assigned_contact_idsinteger[]

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

label_idsinteger[]

Example request

{
  "reported_at": "2023-03-14T13:46:27-06:00",
  "due_date": "2023-03-14T13:46:27-06:00",
  "meter_entry_attributes": {
    "value": 108043
  },
  "secondary_meter_entry_attributes": {
    "value": 108043
  }
}

Response

OK

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

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

numberinteger required

A unique identifier for the Issue.

summarystring required

A summary of the Issue.

descriptionstring nullable required

A longer description of the Issue.

state'open' | 'closed' | 'resolved' required

The Issue's current state.

reported_atstring date-time nullable required

The date and time at which this Issue was reported.

resolvable_type'ServiceEntry' | 'WorkOrder' nullable required

The type of the object which can resolve this Issue.

resolved_atstring date-time nullable required

The date and time at which this Issue was resolved.

resolved_notestring required

Any notes associated with resolving this Issue.

closed_atstring date-time nullable required

The date and time at which this Issue was closed.

closed_notestring required

Any notes associated with closing this Issue.

due_datestring date nullable required

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

due_meter_valuenumber float nullable required

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

due_secondary_meter_valuenumber float nullable required

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

is_overdueboolean required

Indicates whether the Issue is overdue.

creation_type'manual' | 'workflow' required

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

asset_type'Vehicle' | 'Equipment' required

The asset type that has the Issue.

watchers_countinteger

The count of watchers associated with the Issue.

comments_countinteger

The count of Comments associated with the Issue.

images_countinteger

The count of images associated with the Issue.

documents_countinteger

The count of documents associated with the Issue.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "reported_at": "2023-03-14T13:46:27-06:00",
  "resolved_at": "2023-03-14T13:46:27-06:00",
  "closed_at": "2023-03-14T13:46:27-06:00",
  "due_date": "2023-03-14",
  "issue_priority": {
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00"
  }
}

Changes

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