Update Assessment

Updates a given condition assessment.

Resource Information

Scope assessments
App Type Agency
Authorization Type Access token
URI /v4/assessments/{id}?lang={lang}
Automation Version(s) 9.0.0

Request Information

Field or Parameter Type Required Values Description Automation Version
attributes{} {} No Get Attributes Metadata for Condition Assessment Type Contains custom attribute values for the assessment. For the names of the custom attribute fields, use Get Attributes Metadata for Condition Assessment Type. 9.0.0
attributes.<customType> string No   A custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables.
  • For a Text field, the maximum length is 256.
  • For a Number field, any numeric form is allowed, including negative numbers.
  • For a Date field, the format is MM/dd/yyyy. For a Time field, the format is hh:mm.
  • For a TextArea field, the maximum length is 4000 characters, and allows line return characters.
  • For a DropdownList field, the dropdown list values are in the options[] array. For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED".
  • For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No".
comment String No   Comments or notes about the assessment. 9.0.0
conditionAssessment String No Get All Condition Assessment Types The condition assessment type. 9.0.0
inspectionDate String No   The inspection date for the assessment, in yyyy-mm-dd format. 9.0.0
inspectionTime String No   The inspection time for the assessment, in hh:mm AM/PM format. 9.0.0
inspectorId String No Get All Inspectors The ID of the inspector. 9.0.0
scheduleDate String No   The scheduled assessment date, in yyyy-mm-dd format. 9.0.0
scheduleTime String No   The scheduled assessment time, in hh:mm AM/PM format. 9.0.0
status String Yes Completed | Scheduled The status of the condition assessment. Required. 9.0.0
timeSpent String No   The number of hours spent on the assessment. 9.0.0
id string Yes Search Assessments
Get My Assessments
The unique identifier of the assessment, assigned by the Civic Platform server. 9.0.0
lang String No   Indicates the language applied. 9.0.0


Sample Request Head

PUT https://apis.accela.com/v4/assessments/2005

Sample Request Body

  "scheduleDate": "2016-10-31",
  "scheduleTime": "07:29 PM",
  "inspectionDate": "2016-10-31",
  "inspectionTime": "07:29 PM",
  "inspectorId": "jsmith",
  "timeSpent": "1",
  "comment": "Assessment inspection has been rescheduled.",
  "status": "Scheduled"

Response Information

Field Type Description Automation Version
result[] result{}   9.0.0
result.code string A code identifying an associated item 9.0.0
result.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 9.0.0
result.isSuccess boolean Indicates whether or not the operation on the item is successful. 9.0.0
result.message string A text message related to the operation. 9.0.0
status integer The record status. 9.0.0


Sample Response Body

  "status": 200,
  "result": [
      "id": "2005",
      "isSuccess": true