Describe Required Record Attributes

Gets the field and element values the system requires in order to create a specific type of record.

Resource Information

Scoperecords

Deprecated scope name:   get_create_record_describe

App TypeAll
Authorization TypeAccess token
URI /v4/records/describe/create?type={type}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
langStringNo Indicates the language applied.7.3.2
typestringYes The type of entity to be queried.7.3.2

Example

Sample Request Head

GET https://apis.accela.com/v4/records/describe/create?type=Building/Commercial/Alteration/NA

Notes

The following sample request uses the ISLANDTON agency in the TEST environment on the Accela Developer Sandbox. Click the "Send to Hurl.It" link below to submit the sample request. Replace YOUR-ACCESS-TOKEN before submitting the request.

curl
   -H 'Content-type: application/json'
   -H 'Accept: application/json'
   -H 'Authorization: YOUR-ACCESS-TOKEN'
   -X GET  https://apis.accela.com/v4/records/describe/create?type=Building/Commercial/Alteration/NA

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.2
result.elements[]result.elements{}The required metadata for creating a specific type of record.7.3.2
result.elements.isReferencebooleanIndicates whether or not the information is referenced. 7.3.2
result.elements.isRequiredbooleanIndicates whether or not the information is required.7.3.2
result.elements.namestringThe full name for the application contact.7.3.2
result.elements.types[]result.elements.types{}Metadata about the types that apply to the specified object.7.3.2
result.elements.types.maxOccurancelongThe maximum number of times a contact type is used.7.3.2
result.elements.types.minOccurancelongThe minimum number of times a contact type is used.7.3.2
result.elements.types.valuestringThe contact type value.7.3.2
result.fields[]result.fields{}Contains fields and their attributes.7.3.2
result.fields.isRequiredbooleanIndicates whether or not the information is required. 7.3.2
result.fields.namestringThe full name for the application contact.7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "fields": [
      {
        "name": "customId",
        "isRequired": false
      },
      {
        "name": "customForms",
        "isRequired": false
      },
      {
        "name": "type",
        "isRequired": true
      },
      {
        "name": "misdemeanor",
        "isRequired": false
      },
      {
        "name": "inspectorName",
        "isRequired": false
      },
      {
        "name": "enforceDepartment",
        "isRequired": false
      },
      {
        "name": "scheduledDate",
        "isRequired": false
      },
      {
        "name": "customTables",
        "isRequired": false
      },
      {
        "name": "completeUser",
        "isRequired": false
      },
      {
        "name": "housingUnits",
        "isRequired": false
      },
      {
        "name": "description",
        "isRequired": false
      },
      {
        "name": "priority",
        "isRequired": false
      },
      {
        "name": "value",
        "isRequired": false
      },
      {
        "name": "recordClass",
        "isRequired": false
      },
      {
        "name": "enforceUser",
        "isRequired": false
      },
      {
        "name": "inspectorId",
        "isRequired": false
      },
      {
        "name": "estimatedDueDate",
        "isRequired": false
      },
      {
        "name": "actualProductionUnit",
        "isRequired": false
      },
      {
        "name": "defendantSignature",
        "isRequired": false
      },
      {
        "name": "status",
        "isRequired": false
      },
      {
        "name": "appearanceDayOfWeek",
        "isRequired": false
      },
      {
        "name": "trackingId",
        "isRequired": false
      },
      {
        "name": "publicOwned",
        "isRequired": false
      },
      {
        "name": "assignedDate",
        "isRequired": false
      },
      {
        "name": "enforceUserId",
        "isRequired": false
      },
      {
        "name": "completedDate",
        "isRequired": false
      },
      {
        "name": "reportedDate",
        "isRequired": false
      },
      {
        "name": "completedByUser",
        "isRequired": false
      },
      {
        "name": "inPossessionTime",
        "isRequired": false
      },
      {
        "name": "createdByCloning",
        "isRequired": false
      },
      {
        "name": "closedByUser",
        "isRequired": false
      },
      {
        "name": "overallApplicationTime",
        "isRequired": false
      },
      {
        "name": "offenseWitnessed",
        "isRequired": false
      },
      {
        "name": "appearanceDate",
        "isRequired": false
      },
      {
        "name": "closedDate",
        "isRequired": false
      },
      {
        "name": "estimatedProductionUnit",
        "isRequired": false
      },
      {
        "name": "statusDate",
        "isRequired": false
      },
      {
        "name": "infraction",
        "isRequired": false
      },
      {
        "name": "completedByDepartment",
        "isRequired": false
      },
      {
        "name": "completeDate",
        "isRequired": false
      },
      {
        "name": "reportedChannel",
        "isRequired": false
      },
      {
        "name": "assignedToDepartment",
        "isRequired": false
      },
      {
        "name": "closedByDepartment",
        "isRequired": false
      },
      {
        "name": "booking",
        "isRequired": false
      },
      {
        "name": "initiatedProduct",
        "isRequired": false
      },
      {
        "name": "openedDate",
        "isRequired": false
      },
      {
        "name": "reportedType",
        "isRequired": false
      },
      {
        "name": "numberOfBuildings",
        "isRequired": false
      },
      {
        "name": "constructionType",
        "isRequired": false
      },
      {
        "name": "assignedUser",
        "isRequired": false
      },
      {
        "name": "severity",
        "isRequired": false
      },
      {
        "name": "renewalInfo",
        "isRequired": false
      },
      {
        "name": "firstIssuedDate",
        "isRequired": false
      },
      {
        "name": "statusReason",
        "isRequired": false
      },
      {
        "name": "inspectorDepartment",
        "isRequired": false
      },
      {
        "name": "shortNotes",
        "isRequired": false
      }
    ],
    "elements": [
      {
        "name": "parcels",
        "isRequired": true,
        "isReference": false
      },
      {
        "name": "addresses",
        "isRequired": false,
        "isReference": false
      },
      {
        "name": "owners",
        "isRequired": true,
        "isReference": false
      },
      {
        "name": "professionals",
        "isRequired": true,
        "isReference": false
      },
      {
        "name": "contacts",
        "isRequired": true,
        "isReference": false,
        "types": [
          {
            "value": "Veterinarian",
            "maxOccurance": 1,
            "minOccurance": 0
          },
          {
            "value": "Advocate",
            "maxOccurance": 1,
            "minOccurance": 1
          }
        ]
      }
    ]
  }
}