Get All Record Types for Asset Type

Returns all configured record types for a given asset type or asset group.

Resource Information

Scope settings
App Type Agency
Authorization Type Access token
URI /v4/settings/assettypes/recordtypes?assetGroup={assetGroup}&assetType={assetType}&offset={offset}&limit={limit}&fields={fields}&lang={lang}
HTTP Method GET
Automation Version(s) 9.0.0

Request Information

Field or Parameter Type Required Values Description Automation Version
assetGroup string No   The name of the asset group. For example: Water or Street. An Asset Group is an agency-defined collection of objects the agency owns or maintains. 9.0.0
assetType string Yes Get All Asset Types The type of asset. For example: Hydrant or Manhole. An Asset Type is an agencydefined classification of similar objects that share the same standard asset attributes. Related asset types belong to an asset group, and multiple asset types can share the same Class Type. 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{} Contains record type information. 9.0.0
result.alias string The record type alias. 9.0.0
result.associations result.associations{} Contains parameter settings associated with instances of the record type. 9.0.0
result.associations.addressTypeGroup string The name of the address type group that contains permissible address tyeps for instances of the record type. 9.0.0
result.associations.customFormGroup string The name of the custom forms group for instances of the record type. 9.0.0
result.associations.documentCode string The code that defines the document types for the record type. 9.0.0
result.associations.expirationCode string The code that defines the parameters for expiring records that are instances of the record type. 9.0.0
result.associations.feeSchedule string The name of the fee schedule associated with instances of the record type. 9.0.0
result.associations.inspectionGroup string The name of the inspection group that contains the inspection-related parameters applied to instances of the record type. 9.0.0
result.associations.recordStatusGroup string The group of record statuses associated with the record type. 9.0.0
result.associations.standardCommentGroup[] result.associations.standardCommentGroup{} The name of the standard comment group associated with instances of the record type. 9.0.0
result.associations.virtualFolderGroup string The name of the virtual folder group associated with instances of the record type. 9.0.0
result.associations.workflow string The name of the workflow associated with instances of the record type. 9.0.0
result.category string The 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 9.0.0
result.createable Boolean Indicates whether or not the record can be created. 9.0.0
result.deletable Boolean Indicates whether or not the record can be deleted. 9.0.0
result.filterName string The name of the record type filter which defines the record types to be displayed for the citizen user. 9.0.0
result.group string The 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 9.0.0
result.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 9.0.0
result.module string Use to filter by the module. 9.0.0
result.readable Boolean Indicates whether or not values for sibling fields are readable. 9.0.0
result.searchable Boolean Indicates whether or not the item is searchable. "true" : the item is searchable. "false" : the item is not searchable. 9.0.0
result.subType string The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 9.0.0
result.text string The localized display text. 9.0.0
result.type string The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 9.0.0
result.updatable Boolean Whether or not you can update the record. 9.0.0
result.value string The value for the specified parameter. 9.0.0
status integer The record status. 9.0.0