Returns the search results of a given search filter. Note that this request does not require a JSON request body.
| Scope | filters |
| App Type | Agency |
| Authorization Type | Access token |
| URI | /v4/filters/{id}/results?limit={limit}&offset={offset}&fields={fields}&lang={lang} |
| HTTP Method | POST |
| Automation Version(s) | 9.0.0 |
| 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 | Get All Filters | The unique identifier of the search filter, assigned by the Civic Platform server | 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 |
| Field | Type | Description | Automation Version |
|---|---|---|---|
| result[] | result{} | An array containing the search results | 9.0.0 |
| result.<record> | {} | For a record filter, the response fields are similar to Get Records. See also the Sample record filter results. |
9.0.0 |
| result.<inspection> | {} | For an inspection filter, the response fields are similar to Get Inspections. See also the Sample inspection filter results. |
9.0.0 |
| result.<workOrder> | {} | For a work order filter, the response fields are similar to Get Workflow Tasks. See also the Sample work order filter results. |
9.0.0 |
| status | integer | The request status. | 9.0.0 |
{
"result": [
{
"name": "Temporary Banner on side of building",
"id": "BPTDEV-15EST-00000-00163",
"type": {
"module": "Building",
"value": "Building/Sign/Temporary/NA",
"type": "Sign",
"text": "Sign Permit - Temporary",
"group": "Building",
"subType": "Temporary",
"alias": "Sign Permit - Temporary",
"category": "NA",
"id": "Building-Sign-Temporary-NA"
},
"description": "Store advertisement during week long event",
"module": "Building",
"undistributedCost": 0,
"recordClass": "INCOMPLETE EST",
"initiatedProduct": "ACA",
"statusDate": "2015-06-15 16:36:39",
"jobValue": 0,
"customId": "15TMP-000159",
"openedDate": "2015-06-15 00:00:00",
"trackingId": 295437203,
"shortNotes": "Temporary Signage/Banner During Week Event",
"updateDate": "2015-06-15 16:36:39",
"serviceProviderCode": "BPTDEV",
"totalJobCost": 0,
"reportedDate": "2015-06-15 16:36:39",
"createdBy": "PUBLICUSER4281",
"value": "15EST-00000-00163",
"totalFee": 0,
"totalPay": 0,
"balance": 0,
"booking": false,
"infraction": false,
"misdemeanor": false,
"offenseWitnessed": false,
"defendantSignature": false,
"publicOwned": false
}
],
"status": 200,
"page": {
"offset": 0,
"limit": 25,
"hasmore": false
}
}
{
"result": [
{
"address": {
"levelPrefix": "Floor",
"houseAlphaEnd": "C",
"levelEnd": "8",
"levelStart": "1",
"streetStart": 100,
"houseAlphaStart": "A",
"streetEnd": 200,
"secondaryStreetNumber": 1,
"xCoordinate": 84,
"yCoordinate": 152,
"addressLine2": "Bishop Ranch 3",
"addressLine1": "Accela, Inc.",
"id": 1001669168,
"streetAddress": "2633 Camino Ramon",
"isPrimary": "N",
"inspectionDistrict": "San Ramon",
"neighborhoodPrefix": "BR",
"neighborhood": "Sunset",
"streetPrefix": "",
"inspectionDistrictPrefix": "insp",
"description": "Updated Description",
"streetName": "Camino Ramon",
"unitEnd": "uEnd",
"unitStart": "uStart",
"serviceProviderCode": "BPTDEV",
"postalCode": "94583",
"city": "San Ramon",
"addressTypeFlag": {
"value": "A",
"text": "Active"
},
"country": {
"value": "CN",
"text": "China"
},
"houseFractionStart": {
"value": "1/2",
"text": "1/2"
},
"houseFractionEnd": {
"value": "1/4",
"text": "1/4"
},
"status": {
"value": "A",
"text": "Active"
},
"state": {
"value": "CA",
"text": "CA"
},
"streetSuffix": {
"value": "BLVD",
"text": "BLVD"
}
},
"id": 7526940,
"priority": 0,
"publicVisible": "Y",
"type": {
"value": "Set Backs",
"id": 97,
"group": "BLD_COMM",
"text": "Set Backs"
},
"requiredInspection": "N",
"record": {
"name": "storage fire inspection",
"description": "Additional fire inspection",
"status": {
"value": "Ready to Issue",
"text": "Ready to Issue"
},
"updateDate": "2016-06-10 04:31:42",
"value": "DUB16-00000-0039Q",
"totalFee": 0,
"totalPay": 20,
"balance": 0,
"booking": false,
"infraction": false,
"misdemeanor": false,
"offenseWitnessed": false,
"defendantSignature": false,
"publicOwned": false
},
"resultType": "PENDING",
"commentPublicVisible": [
"All"
],
"category": "Insp Pending",
"commentDisplay": "Y",
"requestAMPM": "PM",
"requestTime": "7:13",
"requestorFirstName": "Accela",
"requestorLastName": "Administrator",
"units": 2,
"recordType": {
"value": "Building/Commercial/Fire/Application",
"type": "Commercial",
"module": "Building",
"group": "Building",
"subType": "Fire",
"category": "Application",
"id": "Building-Commercial-Fire-Application"
},
"recordId": {
"id": "BPTDEV-DUB16-00000-0039Q",
"serviceProviderCode": "BPTDEV",
"customId": "16CAP-00001445",
"trackingId": 290227636,
"value": "DUB16-00000-0039Q"
},
"status": {
"value": "Pending",
"text": "Pending"
},
"serviceProviderCode": "BPTDEV",
"isAutoAssign": "N",
"requestDate": "2016-06-11"
}
],
"status": 200,
"page": {
"offset": 0,
"limit": 25,
"hasmore": false
}
}
{
"result": [
{
"assignedDate": "2015-05-05 00:00:00",
"dispositionNote": "",
"description": "Plans Distribution",
"isCompleted": "N",
"dueDate": "2015-05-05 00:00:00",
"isActive": "Y",
"statusDate": "2015-06-03 00:00:00",
"processCode": "BLD_COMM",
"serviceProviderCode": "BPTDEV",
"comment": "",
"id": "14-2",
"recordId": {
"id": "BPTDEV-15CAP-00000-0000A",
"serviceProviderCode": "BPTDEV",
"customId": "nicol-0424",
"trackingId": 231556402,
"value": "15CAP-00000-0000A"
},
"actionbyUser": {
"value": "ADMIN",
"text": "Accela Administrator"
},
"assignedUser": {
"value": "ADMIN",
"text": "Accela Administrator"
},
"status": {
"value": "Note",
"text": "Note"
},
"daysDue": 0
}
],
"status": 200,
"page": {
"offset": 0,
"limit": 25,
"hasmore": false
}
}