Update Record

Updates details for the specified record.

Resource Information

Scoperecords

Deprecated scope name:   update_record

App TypeAll
Authorization TypeAccess token
URI /v4/records/{id}?lang={lang}
HTTP MethodPUT
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo 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.7.3.2
idstringYes The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
langStringNo Indicates the language applied.7.3.2
actualProductionUnitdoubleNo Estimated cost per production unit.8.0.0
appearanceDatedateTimeNo The date for a hearing appearance. 8.0.0
appearanceDayOfWeekstringNo The day for a hearing appearance.8.0.0
assignedDatedateTimeNo The date of the assigned action.8.0.0
assignedToDepartmentstringNo Get All Departments The department responsible for the action.8.0.0
balanceDoubleNo The balance of the account.8.0.0
bookingBooleanNotrue | falseIndicates whether or not there was a booking in addition to a citation.8.0.0
closedByDepartmentstringNo Get All Departments The department responsible for closure. 8.0.0
closedDatedateTimeNo The closure date.8.0.0
completedByDepartmentstringNo Get All Departments The department responsible for completion.8.0.0
completedDatedateTimeNo The date of completion.8.0.0
defendantSignatureBooleanNo Indicates whether or not a defendant's signature has been obtained.8.0.0
descriptionstringNo The description of the record or item.8.0.0
enforceDepartmentstringNo Get All Departments The name of the department responsible for enforcement.8.0.0
estimatedProductionUnitdoubleNo The estimated number of production units.8.0.0
firstIssuedDatedateTimeNo The first issued date for license.8.0.0
infractionBooleanNo This defines whether or not an infraction occurred.8.0.0
inspectorDepartmentstringNo Get All Departments The name of the department where the inspector works. 8.0.0
inspectorIdstringNo Get All Inspectors The ID number of the inspector.8.0.0
inspectorNamestringNo Get All Inspectors The name of the inspector.8.0.0
misdemeanorBooleanNotrue | falseIndicates whether or not a misdemeanor occurred.8.0.0
namestringNo The full name for the application contact.8.0.0
offenseWitnessedBooleanNotrue | falseIndicates whether or not there was a witness to the alleged offense.8.0.0
prioritypriority{}No Get All Priorities The priority level assigned to the record.8.0.0
priority.textstringNo The localized display text.7.3.2
priority.valuestringNo The value for the specified parameter.7.3.2
publicOwnedBooleanNotrue | falseA flag that indicates whether or not the public owns the item.8.0.0
renewalInforenewalInfo{}No Defines the parameters related to renewal of a record. 8.0.0
renewalInfo.expirationDatedateTimeNo The date when the condition expires.7.3.2
renewalInfo.expirationStatusrenewalInfo.expirationStatus{}No Get All Record Expiration Statuses Indicates whether the expiration is enabled or disabled.7.3.2
renewalInfo.expirationStatus.textstringNo The localized display text.7.3.2
renewalInfo.expirationStatus.valuestringNo The value for the specified parameter.7.3.2
reportedChannelreportedChannel{}No The incoming channel through which the applicant submitted the application.8.0.0
reportedChannel.textstringNo The localized display text.7.3.2
reportedChannel.valuestringNo The value for the specified parameter.7.3.2
reportedDatedateTimeNo The date when a complaint or incident is reported.8.0.0
reportedTypereportedType{}No The type of complaint or incident being reported.8.0.0
reportedType.textstringNo The localized display text.7.3.2
reportedType.valuestringNo The value for the specified parameter.7.3.2
scheduledDatedateTimeNo The date when the inspection gets scheduled.8.0.0
severityseverity{}No Indicates the severity of the condition.8.0.0
severity.textstringNo The localized display text.7.3.2
severity.valuestringNo The value for the specified parameter.7.3.2
shortNotesstringNo A brief note about the record subject.8.0.0
statusstatus{}No The record status.8.0.0
status.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2
statusReasonstatusReason{}No The reason for the status setting on the record.8.0.0
statusReason.textstringNo The localized display text.7.3.2
statusReason.valuestringNo The value for the specified parameter.7.3.2
totalFeeDoubleNo The total amount of the fees invoiced to the record. 8.0.0
totalPayDoubleNo The total amount of pay. 8.0.0

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 8.0.0
result.actualProductionUnitdoubleEstimated cost per production unit.8.0.0
result.appearanceDatedateTimeThe date for a hearing appearance. 8.0.0
result.appearanceDayOfWeekstringThe day for a hearing appearance.8.0.0
result.assignedDatedateTimeThe date of the assigned action.8.0.0
result.assignedToDepartmentstringThe department responsible for the action.8.0.0
result.assignedUserstringThe staff member responsible for the action.8.0.0
result.balanceDoubleThe balance of the account.8.0.0
result.bookingBooleanIndicates whether or not there was a booking in addition to a citation.8.0.0
result.closedByDepartmentstringThe department responsible for closure. 8.0.0
result.closedByUserstringThe staff member responsible for closure. 8.0.0
result.closedDatedateTimeThe closure date.8.0.0
result.completedByDepartmentstringThe department responsible for completion.8.0.0
result.completedByUserstringThe staff member responsible for completion. 8.0.0
result.completedDatedateTimeThe date of completion.8.0.0
result.constructionTyperesult.constructionType{}The US Census Bureau construction type code.8.0.0
result.constructionType.textstringThe localized display text.7.3.2
result.constructionType.valuestringThe value for the specified parameter.7.3.2
result.costPerUnitdoubleThe cost for one unit.8.0.0
result.createdBystringThe unique user id of the individual that created the entry.8.0.0
result.createdByCloningstringIndictes whether or not the record was cloned.8.0.0
result.customIdstringAn ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.8.0.0
result.defendantSignatureBooleanIndicates whether or not a defendant's signature has been obtained.8.0.0
result.descriptionstringThe description of the record or item.8.0.0
result.enforceDepartmentstringThe name of the department responsible for enforcement.8.0.0
result.enforceUserstringName of the enforcement officer. 8.0.0
result.enforceUserIdstringID number of the enforcement officer.8.0.0
result.estimatedCostPerUnitdoubleThe estimated cost per unit. 8.0.0
result.estimatedDueDatedateTimeThe estimated date of completion.8.0.0
result.estimatedProductionUnitdoubleThe estimated number of production units.8.0.0
result.estimatedTotalJobCostdoubleThe estimated cost of the job.8.0.0
result.firstIssuedDatedateTimeThe first issued date for license.8.0.0
result.housingUnitslongThe number of housing units.8.0.0
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.8.0.0
result.infractionBooleanThis defines whether or not an infraction occurred.8.0.0
result.initiatedProductstringThe Accela Automation product area where the application is submitted: "AA" : Classic Accela Automation. "ACA" : Accela Citizen Access. "AIVR" : Accela Integrated Voice Response. "AMO" : Accela Mobile Office. "AV360" : Accela Asset Management, Accela Land Man. 8.0.0
result.inPossessionTimedoubleThe application level in possession time of the time tracking feature.8.0.0
result.inspectorDepartmentstringThe name of the department where the inspector works. 8.0.0
result.inspectorIdstringThe ID number of the inspector.8.0.0
result.inspectorNamestringThe name of the inspector.8.0.0
result.jobValuedoubleThe value of the job.8.0.0
result.misdemeanorBooleanIndicates whether or not a misdemeanor occurred.8.0.0
result.modulestringUse to filter by the module.8.0.0
result.namestringThe full name for the application contact.8.0.0
result.numberOfBuildingslongThe number of buildings.8.0.0
result.offenseWitnessedBooleanIndicates whether or not there was a witness to the alleged offense.8.0.0
result.openedDatedateTimeThe date when the system created the record.8.0.0
result.overallApplicationTimedoubleThe amount of elapsed time from the time tracking start date to the completion of the application.8.0.0
result.priorityresult.priority{}The priority level assigned to the record.8.0.0
result.priority.textstringThe localized display text.7.3.2
result.priority.valuestringThe value for the specified parameter.7.3.2
result.publicOwnedBooleanA flag that indicates whether or not the public owns the item.8.0.0
result.recordClassstringGeneral information about the record. 8.0.0
result.renewalInforesult.renewalInfo{}Defines the parameters related to renewal of a record. 8.0.0
result.renewalInfo.expirationDatedateTimeThe date when the condition expires.7.3.2
result.renewalInfo.expirationStatusresult.renewalInfo.expirationStatus{}Indicates whether the expiration is enabled or disabled.7.3.2
result.renewalInfo.expirationStatus.textstringThe localized display text.7.3.2
result.renewalInfo.expirationStatus.valuestringThe value for the specified parameter.7.3.2
result.reportedChannelresult.reportedChannel{}The incoming channel through which the applicant submitted the application.8.0.0
result.reportedChannel.textstringThe localized display text.7.3.2
result.reportedChannel.valuestringThe value for the specified parameter.7.3.2
result.reportedDatedateTimeThe date when a complaint or incident is reported.8.0.0
result.reportedTyperesult.reportedType{}The type of complaint or incident being reported.8.0.0
result.reportedType.textstringThe localized display text.7.3.2
result.reportedType.valuestringThe value for the specified parameter.7.3.2
result.scheduledDatedateTimeThe date when the inspection gets scheduled.8.0.0
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.8.0.0
result.severityresult.severity{}Indicates the severity of the condition.8.0.0
result.severity.textstringThe localized display text.7.3.2
result.severity.valuestringThe value for the specified parameter.7.3.2
result.shortNotesstringA brief note about the record subject.8.0.0
result.statusresult.status{}The record status.8.0.0
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.statusDatedateTimeThe date when the current status changed.8.0.0
result.statusReasonresult.statusReason{}The reason for the status setting on the record.8.0.0
result.statusReason.textstringThe localized display text.7.3.2
result.statusReason.valuestringThe value for the specified parameter.7.3.2
result.totalFeeDoubleThe total amount of the fees invoiced to the record. 8.0.0
result.totalJobCostdoubleThe combination of work order assignments (labor) and costs. 8.0.0
result.totalPayDoubleThe total amount of pay. 8.0.0
result.trackingIdlongThe application tracking number (IVR tracking number).8.0.0
result.typeresult.type{}The record type. If this type field is within the record type definition, it specifies the 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 8.0.0
result.type.aliasstringThe record type alias.7.3.2
result.type.categorystringThe 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.filterNamestringThe name of the record type filter which defines the record types to be displayed for the citizen user.7.3.2
result.type.groupstringThe 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.type.modulestringUse to filter by the module.7.3.2
result.type.subTypestringThe 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.textstringThe localized display text.7.3.2
result.type.typestringThe 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
result.undistributedCostdoubleThe undistributed costs for this work order.8.0.0
result.valuestringThe value for the specified parameter.8.0.0
statusintegerThe record status.7.3.3