- Scope: create_assessment
- URL: https://apis.accela.com/v3/assessments/
- HTTP Method: POST
- Headers:
- Content-Type: application/json
- Authorization: token
{
"assetCA": {
"assetId": "262963-3205",
"status": {
"id": "Scheduled",
"display": "Scheduled",
"name": "Scheduled"
},
"type": {
"id": "CCTV",
"display": "CCTV"
},
"scheduleDate": "2014-10-31",
"scheduleTime": "09:18 AM",
"inspectionDate": "2014-10-31",
"department": {
"id": "ASSET-NA-NA-NA-NA-NA",
"display": "Asset Management",
"agencyCode": "ASSET",
"bureauCode": "NA",
"divisionCode": "NA",
"sectionCode": "NA",
"groupCode": "NA",
"subgroupCode": "NA",
"subgroupCodeDesc": "Asset Management",
"staff": [
{
"id": "JJOHNSON",
"display": "J Johnson",
"firstName": "J",
"lastName": "Johnson",
"auditStatus": "A",
"serviceProviderCode": "PARTNERMSTR",
"userID": "JJOHNSON",
"agencyCode": "ASSET",
"bureauCode": "NA",
"divisionCode": "NA",
"sectionCode": "NA",
"groupCode": "NA",
"officeCode": "NA"
}
]
},
"staffPerson": {
"id": "JJOHNSON",
"display": "J Johnson",
"firstName": "J",
"lastName": "Johnson",
"auditStatus": "A",
"serviceProviderCode": "PARTNERMSTR",
"userID": "JJOHNSON",
"agencyCode": "ASSET",
"bureauCode": "NA",
"divisionCode": "NA",
"sectionCode": "NA",
"groupCode": "NA",
"officeCode": "NA"
},
"timeSpent": "0",
"comment": "Use these as your remarks"
}
}- InspectionDate = "inspectionDate": "2014-10-31"
- Operator = staffPerson object, we can talk more about the department details
- Remark = comment
{
"id": "524"
}The first thing to do here would be to call the Describe Assessment Attributes. This request will provide metadata needed to make a Create Assessment Attributes request. You will take the describe response and add the value attribute to each item you need to provide data for and ensure that the entityState attribute is set to "Added".
- Scope: create_assessment_attributes
- URL: https://apis.accela.com/v3/assessments/
- HTTP Method: POST
- Headers:
- Content-Type: application/json
- Authorization: token
{
"attributes": [
{
"id": "524",
"display": "524",
"description": "test",
"subGroups": [
{
"id": "524",
"display": "524",
"items": [
{
"id": "Direction",
"display": "Direction",
"value": "Downstream",
"name": "CCTV_Direction",
"type": "Enumeration",
"enumerations": [
{
"id": "Downstream",
"display": "Downstream"
},
{
"id": "Upstream",
"display": "Upstream"
}
],
"maxValue": 10,
"inputRequired": true,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Added"
},
{
"id": "City",
"display": "City",
"name": "CCTV City",
"type": "Text",
"maxValue": 20,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Pre.1Cleaning",
"display": "Pre-Cleaning",
"value": "Heavy Cleaning",
"name": "CCTV Pre-Cleaning",
"type": "Enumeration",
"enumerations": [
{
"id": "Heavy Cleaning",
"display": "Heavy Cleaning"
},
{
"id": "Jetting",
"display": "Jetting"
},
{
"id": "No Pre-Cleaning",
"display": "No Pre-Cleaning"
},
{
"id": "Not Known",
"display": "Not Known"
}
],
"maxValue": 10,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Added"
},
{
"id": "Owner",
"display": "Owner",
"name": "CCTV Owner",
"type": "Text",
"maxValue": 30,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Customer",
"display": "Customer",
"name": "CCTV Customer",
"type": "Text",
"maxValue": 30,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Date.cCleaned",
"display": "Date Cleaned",
"value": "2014-10-31",
"name": "CCTV_Date_Cleaned",
"type": "Date",
"maxValue": 10,
"inputRequired": true,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Added"
},
{
"id": "Weather",
"display": "Weather",
"name": "CCTV Weather",
"value": "Dry",
"type": "Enumeration",
"enumerations": [
{
"id": "Damp",
"display": "Damp"
},
{
"id": "Dry",
"display": "Dry"
},
{
"id": "Heavy Rain",
"display": "Heavy Rain"
},
{
"id": "Light Rain",
"display": "Light Rain"
},
{
"id": "Saturated",
"display": "Saturated"
},
{
"id": "Snow",
"display": "Snow"
}
],
"maxValue": 10,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Added"
},
{
"id": "PO.cNumber",
"display": "PO Number",
"name": "CCTV PO Number",
"type": "Text",
"maxValue": 15,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Media.cLabel",
"display": "Media Label",
"name": "CCTV_Media_Label",
"type": "Text",
"maxValue": 64,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Certificate.cNumber",
"display": "Certificate Number",
"name": "CCTV_Certificate_Number",
"type": "Text",
"maxValue": 15,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Sheet.cNumber",
"display": "Sheet Number",
"name": "CCTV Sheet Number",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Location.cDetails",
"display": "Location Details",
"name": "CCTV_Location_Details",
"type": "TextArea",
"maxValue": 10,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Upstream.cManhole",
"display": "Upstream Manhole",
"name": "CCTV Upstream Manhole",
"type": "Text",
"maxValue": 25,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Downstream.cManhole",
"display": "Downstream Manhole",
"name": "CCTV Downstream Manhole",
"type": "Text",
"maxValue": 25,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Pipe.cSegment.cReference",
"display": "Pipe Segment Reference",
"name": "CCTV Pipe Segment Reference",
"type": "Text",
"maxValue": 25,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Location.cCode",
"display": "Location Code",
"name": "CCTV_Location_Code",
"type": "Enumeration",
"enumerations": [
{
"id": "A - Main Highway - Urban",
"display": "A - Main Highway - Urban"
},
{
"id": "B - Main Highway - Suburban",
"display": "B - Main Highway - Suburban"
},
{
"id": "C - Light Highway",
"display": "C - Light Highway"
},
{
"id": "D - Easement/Righ of Way",
"display": "D - Easement/Righ of Way"
},
{
"id": "E - Woods",
"display": "E - Woods"
},
{
"id": "F - Sidewalk",
"display": "F - Sidewalk"
},
{
"id": "G - Parking Lot",
"display": "G - Parking Lot"
},
{
"id": "H - Alley",
"display": "H - Alley"
},
{
"id": "I - Ditch",
"display": "I - Ditch"
},
{
"id": "J - Building",
"display": "J - Building"
},
{
"id": "K - Creek",
"display": "K - Creek"
},
{
"id": "L - Railway",
"display": "L - Railway"
},
{
"id": "M - Airport",
"display": "M - Airport"
},
{
"id": "Y - Yard",
"display": "Y - Yard"
},
{
"id": "Z - Other",
"display": "Z - Other"
}
],
"maxValue": 10,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Sewer.cMaterial",
"display": "Sewer Material",
"name": "CCTV Sewer Material",
"type": "Enumeration",
"enumerations": [
{
"id": "Asbestos Cement",
"display": "Asbestos Cement"
},
{
"id": "Brick",
"display": "Brick"
},
{
"id": "Cast Iron",
"display": "Cast Iron"
},
{
"id": "Clay Tile",
"display": "Clay Tile"
},
{
"id": "Concrete Pipe (non-reinforced)",
"display": "Concrete Pipe (non-reinforced)"
},
{
"id": "Concrete Segments (bolted)",
"display": "Concrete Segments (bolted)"
},
{
"id": "Concrete Segments (unbolted)",
"display": "Concrete Segments (unbolted)"
},
{
"id": "Corrugated Metal Pipe",
"display": "Corrugated Metal Pipe"
},
{
"id": "Ductile Iron Pipe",
"display": "Ductile Iron Pipe"
},
{
"id": "Fiberglass Reinforced Cement",
"display": "Fiberglass Reinforced Cement"
},
{
"id": "Glass Reinforced Cement",
"display": "Glass Reinforced Cement"
},
{
"id": "Not Known",
"display": "Not Known"
},
{
"id": "Other",
"display": "Other"
},
{
"id": "Pitch Fiber (Orangeburg)",
"display": "Pitch Fiber (Orangeburg)"
},
{
"id": "Plastic/Steel Composite",
"display": "Plastic/Steel Composite"
},
{
"id": "Polyethylene",
"display": "Polyethylene"
},
{
"id": "Polypropylene",
"display": "Polypropylene"
},
{
"id": "Polyvinyl Chloride",
"display": "Polyvinyl Chloride"
},
{
"id": "Reinforced Concrete Pipe",
"display": "Reinforced Concrete Pipe"
},
{
"id": "Reinforced Plastic Pipe",
"display": "Reinforced Plastic Pipe"
},
{
"id": "Steel Pipe",
"display": "Steel Pipe"
},
{
"id": "Transite Pipe",
"display": "Transite Pipe"
},
{
"id": "Vitrified Clay Pipe",
"display": "Vitrified Clay Pipe"
},
{
"id": "Wood",
"display": "Wood"
}
],
"maxValue": 10,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Sewer.cHeight",
"display": "Sewer Height",
"name": "CCTV Sewer Height",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Length.cSurveyed",
"display": "Length Surveyed",
"value": "12",
"name": "CCTV_Length_Surveyed",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Added"
},
{
"id": "Pipe.cJoint.cLength",
"display": "Pipe Joint Length",
"name": "CCTV Pipe Joint Length",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Flow.cControl",
"display": "Flow Control",
"value": "B - Bypassed",
"name": "CCTV_Flow_Control",
"type": "Enumeration",
"enumerations": [
{
"id": "B - Bypassed",
"display": "B - Bypassed"
},
{
"id": "D - De-Watered using Jetter",
"display": "D - De-Watered using Jetter"
},
{
"id": "L - Lift Station",
"display": "L - Lift Station"
},
{
"id": "N - Not Controlled",
"display": "N - Not Controlled"
},
{
"id": "P - Plugged",
"display": "P - Plugged"
}
],
"maxValue": 10,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Added"
},
{
"id": "Use.cof.cSewer",
"display": "Use of Sewer",
"name": "CCTV_Sewer_Use",
"type": "Enumeration",
"enumerations": [
{
"id": "CB - Combined",
"display": "CB - Combined"
},
{
"id": "FM - Force Main",
"display": "FM - Force Main"
},
{
"id": "PR - Processes",
"display": "PR - Processes"
},
{
"id": "SS - Sanitary Sewer",
"display": "SS - Sanitary Sewer"
},
{
"id": "SW - Stormwater",
"display": "SW - Stormwater"
},
{
"id": "ZZ - Other",
"display": "ZZ - Other"
}
],
"maxValue": 10,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Rim.cInvert.cUp",
"display": "Rim Invert Up",
"name": "CCTV RIM_INVERT_U",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Purpose",
"display": "Purpose",
"value": "A - Maintenance Related",
"name": "CCTV_Purpose",
"type": "Enumeration",
"enumerations": [
{
"id": "A - Maintenance Related",
"display": "A - Maintenance Related"
},
{
"id": "B - Infiltration/Inflow Invest",
"display": "B - Infiltration/Inflow Invest"
},
{
"id": "C - Post Rehab Survey",
"display": "C - Post Rehab Survey"
},
{
"id": "C - Pre-Rehab Survey",
"display": "C - Pre-Rehab Survey"
},
{
"id": "E - Pre-Acceptance, New Sewer",
"display": "E - Pre-Acceptance, New Sewer"
},
{
"id": "F - Routine Assessment",
"display": "F - Routine Assessment"
},
{
"id": "G - CIP Assessment",
"display": "G - CIP Assessment"
},
{
"id": "H - Resurvey for any reason",
"display": "H - Resurvey for any reason"
},
{
"id": "V - Reversal",
"display": "V - Reversal"
},
{
"id": "Z - Not Known",
"display": "Z - Not Known"
}
],
"maxValue": 10,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Added"
},
{
"id": "RIM.cGrade.cUp",
"display": "RIM Grade Up",
"name": "CCTV RIM_GRADE_U",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Sewer.cCategory",
"display": "Sewer Category",
"name": "CCTV Sewer Category",
"type": "Text",
"maxValue": 2,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Pre.1Cleaning",
"display": "Pre-Cleaning",
"value": "H - Heavy Cleaning",
"name": "CCTV_Pre-Cleaning",
"type": "Enumeration",
"enumerations": [
{
"id": "H - Heavy Cleaning",
"display": "H - Heavy Cleaning"
},
{
"id": "J - Jetting",
"display": "J - Jetting"
},
{
"id": "N - No Pre-Cleaning",
"display": "N - No Pre-Cleaning"
},
{
"id": "Z - Not Known",
"display": "Z - Not Known"
}
],
"maxValue": 10,
"inputRequired": true,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Added"
},
{
"id": "Year.cLaid",
"display": "Year Laid",
"name": "CCTV Year Laid",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Sewer.cWidth",
"display": "Sewer Width",
"name": "CCTV Sewer Width",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Rim.cInvert.cDown",
"display": "Rim Invert Down",
"name": "CCTV RIM_INVERT_D",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Year.cRenewed",
"display": "Year Renewed",
"name": "CCTV Year Renewed",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Lining.cMethod",
"display": "Lining Method",
"name": "CCTV Lining Method",
"type": "Enumeration",
"enumerations": [
{
"id": "Cured In Place",
"display": "Cured In Place"
},
{
"id": "Fold and Form or Deform/Reform",
"display": "Fold and Form or Deform/Reform"
},
{
"id": "Other",
"display": "Other"
},
{
"id": "Segmented Panel",
"display": "Segmented Panel"
},
{
"id": "Segmented Pipe",
"display": "Segmented Pipe"
},
{
"id": "Spiral Wound",
"display": "Spiral Wound"
}
],
"maxValue": 10,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Grade.cInvert.cDown",
"display": "Grade Invert Down",
"name": "CCTV GRD_INVERT_D",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Weather",
"display": "Weather",
"value": "1 - Dry",
"name": "CCTV_Weather",
"type": "Enumeration",
"enumerations": [
{
"id": "1 - Dry",
"display": "1 - Dry"
},
{
"id": "2 - Heavy Rain",
"display": "2 - Heavy Rain"
},
{
"id": "3 - Light Rain",
"display": "3 - Light Rain"
},
{
"id": "4 - Snow",
"display": "4 - Snow"
},
{
"id": "5 - Saturated",
"display": "5 - Saturated"
},
{
"id": "6 - Damp",
"display": "6 - Damp"
},
{
"id": "7 - Very Dry",
"display": "7 - Very Dry"
}
],
"maxValue": 10,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Added"
},
{
"id": "Rim.cGrade.cDown",
"display": "Rim Grade Down",
"name": "CCTV RIM_GRADE_D",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Reverse.cSetup",
"display": "Reverse Setup",
"name": "CCTV_Reverse_Setup",
"type": "Float",
"maxValue": 2147483647,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
},
{
"id": "Additional.cInfo",
"display": "Additional Info",
"name": "CCTV Additional Info",
"type": "TextArea",
"maxValue": 255,
"isDrillDown": false,
"isDrillDownRoot": false,
"entityState": "Unchanged"
}
],
"entityState": "Added"
}
]
}
]
}Note that the names of the attributes in Accela are configurable and each customer might call these items something different.
- Weather = Weather
- WONumber = still need to figure out where this goes
- ReasonOfInspection = Purpose
- Cleaned = Pre.1Cleaning
- CleanedDate = Date.cCleaned
- FlowControl = Flow.cControl
- InspectionDirection = Direction
- InspectedLength = Length.cSurveyed
{
"attributes": [
{
"id": "524",
"subGroups": [
{
"id": "524",
"items": [
{
"id": "Direction",
"value": "Downstream"
},
{
"id": "City",
"value": ""
},
{
"id": "Pre.1Cleaning",
"value": "Heavy Cleaning"
},
{
"id": "Owner",
"value": ""
},
{
"id": "Customer",
"value": ""
},
{
"id": "Date.cCleaned",
"value": "2014-10-31"
},
{
"id": "Weather",
"value": "Dry"
},
{
"id": "PO.cNumber",
"value": ""
},
{
"id": "Media.cLabel",
"value": ""
},
{
"id": "Certificate.cNumber",
"value": ""
},
{
"id": "Sheet.cNumber",
"value": ""
},
{
"id": "Location.cDetails",
"value": ""
},
{
"id": "Upstream.cManhole",
"value": ""
},
{
"id": "Downstream.cManhole",
"value": ""
},
{
"id": "Pipe.cSegment.cReference",
"value": ""
},
{
"id": "Location.cCode",
"value": ""
},
{
"id": "Sewer.cMaterial",
"value": ""
},
{
"id": "Sewer.cHeight",
"value": ""
},
{
"id": "Length.cSurveyed",
"value": "12"
},
{
"id": "Pipe.cJoint.cLength",
"value": ""
},
{
"id": "Flow.cControl",
"value": "B - Bypassed"
},
{
"id": "Use.cof.cSewer",
"value": ""
},
{
"id": "Rim.cInvert.cUp",
"value": ""
},
{
"id": "Purpose",
"value": "A - Maintenance Related"
},
{
"id": "RIM.cGrade.cUp",
"value": ""
},
{
"id": "Sewer.cCategory",
"value": ""
},
{
"id": "Pre.1Cleaning",
"value": "H - Heavy Cleaning"
},
{
"id": "Year.cLaid",
"value": ""
},
{
"id": "Sewer.cWidth",
"value": ""
},
{
"id": "Rim.cInvert.cDown",
"value": ""
},
{
"id": "Year.cRenewed",
"value": ""
},
{
"id": "Lining.cMethod",
"value": ""
},
{
"id": "Grade.cInvert.cDown",
"value": ""
},
{
"id": "Weather",
"value": "1 - Dry"
},
{
"id": "Rim.cGrade.cDown",
"value": ""
},
{
"id": "Reverse.cSetup",
"value": ""
},
{
"id": "Additional.cInfo",
"value": ""
}
]
}
]
}
]
}