New Construct V4 API for Civic Platform 9.0.0

Addresses/Conditions

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All Address Conditions All addresses Access token GET /v4/addresses/{id}/conditions 9.0.0

Assessments

Name App Type Scope Auth Type Resource URI Civic Platform version
Create Assessment for Asset Agency assessments Access token POST /v4/assets/{id}/assessments 9.0.0
Delete Assessments Agency assessments Access token DELETE /v4/assessments/{ids} 9.0.0
Get Assessments Agency assessments Access token GET /v4/assessments/{id} 9.0.0
Get My Assessments Agency assessments Access token GET /v4/assessments/mine 9.0.0
Update Assessment Agency assessments Access token PUT /v4/assessments/{id} 9.0.0

Assessments/Attributes

Name App Type Scope Auth Type Resource URI Civic Platform version
Get Attributes Metadata for Condition Assessment Type Agency assessments Access token GET /v4/assessments/{id}/attributes/meta 9.0.0

Assessments/Documents

Name App Type Scope Auth Type Resource URI Civic Platform version
Create Assessment Documents Agency assessments Access token POST /v4/assessments/{assessmentId}/documents 9.0.0
Delete Assessment Documents Agency assessments Access token DELETE /v4/assessments/{assessmentId}/documents/{documentIds} 9.0.0
Get All Assessment Documents Agency assessments Access token GET /v4/assessments/{assessmentId}/documents 9.0.0

Assessments/Observations

Name App Type Scope Auth Type Resource URI Civic Platform version
Get Condition Assessment Observations Agency assessments Access token GET /v4/assessments/{id}/observations 9.0.0
Get Observations Metadata for Condition Assessment Type Agency assessments Access token GET /v4/assessments/{id}/observations/meta 9.0.0
Update Assessment Observations Agency assessments Access token PUT /v4/assessments/{id}/observations 9.0.0

Assessments/Records

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All Assessment Records Agency assessments Access token GET /v4/assessments/{caId}/records 9.0.0

Assessments/WorkOrders

Name App Type Scope Auth Type Resource URI Civic Platform version
Add Work Orders to Assessment Agency assessments Access token POST /v4/assessments/{id}/workorders 9.0.0

Assets

Name App Type Scope Auth Type Resource URI Civic Platform version
Delete Assets Agency assets Access token DELETE /v4/assets/{ids} 9.0.0
Get All Assets Agency assets Access token GET /v4/assets 9.0.0
Get All Linked Assets Agency assets Access token GET /v4/assets/{id}/linkedAssets 9.0.0
Get Assets Agency assets Access token GET /v4/assets/{ids} 9.0.0
Update Asset Agency assets Access token PUT /v4/assets/{id} 9.0.0

Assets/Assessments

Name App Type Scope Auth Type Resource URI Civic Platform version
Create Asset Assessment Agency assessments Access token POST /v4/assets/{id}/assessments 9.0.0

Assets/Attributes

Name App Type Scope Auth Type Resource URI Civic Platform version
Get Asset Custom Attributes Agency assets Access token GET /v4/assets/{id}/attributes 9.0.0
Get Attributes Metadata for Asset Agency assets Access token GET /v4/assets/{id}/attributes/meta 9.0.0
Update Asset Custom Attributes Agency assets Access token PUT /v4/assets/{id}/attributes 9.0.0

Assets/Documents

Name App Type Scope Auth Type Resource URI Civic Platform version
Create Asset Documents Agency  assets Access token POST /v4/assets/{assetId}/documents 9.0.0
Delete Asset Documents Agency assets Access token DELETE /v4/assets/{assetId}/documents/{documentIds} 9.0.0
Get All Asset Documents Agency assets Access token GET /v4/assets/{assetId}/documents 9.0.0

Assets/Records

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All Asset Records Agency assets Access token GET /v4/assets/{assetId}/records 9.0.0

Filters

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All Filters Agency filters Access token GET /v4/filters 9.0.0
Get Filter Results Agency filters Access token POST /v4/filters/{id}/results 9.0.0

Invoices

Name App Type Scope Auth Type Resource URI Civic Platform version
Get Invoices Agency invoices Access token GET /v4/invoices/{invoiceIds} 9.0.0

Payments

Name App Type Scope Auth Type Resource URI Civic Platform version
Void Payment Agency payments Access token PUT /v4/payments/{paymentId}/void 9.0.0

Records/Assets

Name App Type Scope Auth Type Resource URI Civic Platform version
Add Assets to Record Agency records Access token POST /v4/records/{recordId}/assets 9.0.0
Delete Assets from Record Agency records Access token DELETE /v4/records/{recordId}/assets/{ids} 9.0.0
Get All Assets for Record Agency records Access token GET /v4/records/{recordId}/assets 9.0.0

Records/Conditions

Name App Type Scope Auth Type Resource URI Civic Platform version
Get History for Record Condition All records Access token GET /v4/records/{recordId}/conditions/{id}/histories 9.0.0

Records/Costs

Name App Type Scope Auth Type Resource URI Civic Platform version
Delete Record Costs All records Access token DELETE /v4/records/{recordId}/costs/{ids} 9.0.0
Get Record Costs All records Access token GET /v4/records/{recordId}/costs 9.0.0

Records/Invoices

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All Record Invoices Agency records Access token GET /v4/records/{recordId}/invoices 9.0.0

Records/Payments

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All Payments for Record All records Access token GET /v4/records/{recordId}/payments 9.0.0

Searches

Name App Type Scope Auth Type Resource URI Civic Platform version
Search Assessments Agency assessments Access token POST /v4/search/assessments 9.0.0

Settings/Assessments

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All Condition Assessment Types Agency assessments Access token GET /v4/settings/assessments/types 9.0.0

Settings/Assets

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All Asset Groups Agency assets Access token GET /v4/settings/assets/groups 9.0.0
Get All Asset Size Units Agency assets Access token GET /v4/settings/assets/sizeUnits 9.0.0
Get All Asset Statuses Agency assets Access token GET /v4/settings/assets/statuses 9.0.0

Settings/AssetTypes

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All Asset Class Types Agency assets Access token GET /v4/settings/assettypes/classTypes 9.0.0
Get All Asset Rating Types Agency assets Access token GET /v4/settings/assettypes/ratingTypes 9.0.0
Get All Asset Record Types Agency settings Access token GET /v4/settings/assettypes/recordtypes 9.0.0
Get All Asset Types Agency assets Access token GET /v4/settings/assettypes/types 9.0.0
Get All Asset Usage Types Agency assets Access token GET /v4/settings/assettypes/usageTypes 9.0.0

Settings/Payments

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All Payment Refund Reasons All settings Access token GET /v4/settings/payments/refundReasons 9.0.0
Get All Payment Void Reasons All settings Access token GET /v4/settings/payments/voidReasons 9.0.0

Settings/Records

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All Asset Types for Record Type Agency records Access token GET /v4/settings/records/types/{recordTypeId}/assetTypes 9.0.0

Users

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All User Groups Agency users Access token GET /v4/users/{user_id}/groups 9.0.0
Get My User Account Agency users Access token GET /v4/users/me 9.0.0