Search Assessments

Searches condition assessment.

Resource Information

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

Request Information

Field or Parameter Type Required Values Description Automation Version
asset asset{} No   Contains asset information. 9.0.0
asset.description string No   The asset description. 9.0.0
asset.group string No Get Asset Groups The group the asset belongs to. 9.0.0
asset.id string No Get All Assets The unique identifier of the asset, assigned by the Civic Platform server. 9.0.0
asset.status asset.status{} No Get Asset Statuses The asset status. 9.0.0
asset.status.text string No   The localized display text. 9.0.0
asset.status.value string No   The value for the specified parameter. 9.0.0
asset.type string No Get Asset Types The asset type. 9.0.0
assetCAID long No   The asset condition assessment ID. 9.0.0
assignedToDepartment string No Get All Departments The department responsible for the assessment. 9.0.0
attributes attributes{} No Get Attributes Metadata for Assessesment Type Contains assessment attributes. 9.0.0
comments string No   The name of the inspector performing the assessment. 9.0.0
inspectorFullName string No   The unique identifier of the inspector. 9.0.0
inspectorId string No Get All Inspectors The date when the assessment is scheduled. 9.0.0
scheduledDate dateTime No   The scheduled assessment date, in yyyy-mm-dd format. 9.0.0
scheduledTime string No   The scheduled assessment time, in hh:mm AM/PM format. 9.0.0
status string No   The assessment status. 9.0.0
timeSpent double No   The number of hours spent on the assessment. 9.0.0
type string No Get Assessment Types The type of assessment. 9.0.0
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
lang String No   Indicates the language applied. 9.0.0
limit long No   Indicates the number of items that are returned in each page. 9.0.0
offset long No   Indicates the offset start of each page by the number specified. 9.0.0

Response Information

Field Type Description Automation Version
result result{}   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 asset condition assessment ID. 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 The name of the inspector performing the assessment. 9.0.0
result.inspectorFullName string The unique identifier of the inspector. 9.0.0
result.inspectorId string The date when the assessment is scheduled. 9.0.0
result.scheduledDate dateTime The scheduled assessment date, in yyyy-mm-dd format. 9.0.0
result.scheduledTime string The scheduled assessment time, in hh:mm AM/PM format. 9.0.0
result.status string The assessment status. 9.0.0
result.timeSpent double The number of hours spent on the assessment. 9.0.0
result.type string The type of assessment. 9.0.0
status integer The record status. 9.0.0