Get Assessments

Gets condition assessment information for one or more given assessments, identified in comma-separated {ids}.

Resource Information

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

Request Information

Field or Parameter Type Required Values Description Automation Version
fields string No   Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored. 9.0.0
id string No Search Assessments
Get My Assessments
The unique identifier for the condition assessment assigned by the Civic Platform server. 9.0.0
lang String No   Indicates the language applied. 9.0.0

Response Information

Field Type Description Automation Version
result[] result{} Contains condition assessment information. 9.0.0
result.asset result.asset{} Contains asset information. 9.0.0
result.asset.description string The asset description. 9.0.0
result.asset.group string The group the asset belongs to. 9.0.0
result.asset.id string The unique identifier of the asset, assigned by the Civic Platform server. 9.0.0
result.asset.status result.asset.status{} The asset status. 9.0.0
result.asset.status.text string The localized display text. 9.0.0
result.asset.status.value string The value for the specified parameter. 9.0.0
result.asset.type string The asset type. 9.0.0
result.assetCAID long The id of the asset condition assessment. 9.0.0
result.assignedToDepartment string The department responsible for the assessment. 9.0.0
result.attributes result.attributes{} The assessment attributes 9.0.0
result.comments string Comments about the asset condition assessment. 9.0.0
result.inspectorFullName string The name of the inspector performing the assessment. 9.0.0
result.inspectorId string The unique identifier of the inspector. 9.0.0
result.scheduledDate dateTime The date when the assessment is scheduled. 9.0.0
result.scheduledTime string The scheduled time used with the scheduled date for the asset condition assessment. 9.0.0
result.status string The assessment status. 9.0.0
result.timeSpent double The amount of time spent on the asset condition assessment. 9.0.0
result.type string The type of assessment. 9.0.0
status integer The request status. 9.0.0