Get All Custom Forms Metadata for Record Workflow Task

Resource Information

Scope	records Deprecated scope name: get_record_workflow_task_customforms_meta
Scope Group(s)	records
App Type	Agency
Authorization Type	Access token
URI	/v4/records/{recordId}/workflowTasks/{taskId}/customForms/meta?fields={fields}&lang={lang}
HTTP Method	GET
Automation Version(s)	8.0.3

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
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.	8.0.3
lang	String	No		Indicates the language applied.	8.0.3
recordId	string	Yes	Get All Records Search Records Get My Records	The unique ID associated with a record.	8.0.3
taskId	string	Yes	Get All Workflow Tasks for Record	The unique id of the workflow task assigned by the Civic Platform server.	8.0.3

Example

Sample Request Head

GET https://apis.accela.com/v4/records/ISLANDTON-16CAP-00000-001SA/workflowTasks/1-2/customForms/meta

Response Information

Field	Type	Description	Automation Version
result[]	result{}	An arracy containing the custom forms metadata, each of which is a set of custom field definitions.	8.0.3
result.displayOrder	long	The order of the item in comparison to the other items.	8.0.3
result.fields[]	result.fields{}	Contains fields and their attributes.	8.0.3
result.fields.displayOrder	long	The order of the item in comparison to the other items.	8.0.3
result.fields.drillDown	result.fields.drillDown{}	The drilldown information containing children records.	8.0.3
result.fields.drillDown.children[]	result.fields.drillDown.children{}	The drilldown records for application-specific information (ASI) tables	8.0.3
result.fields.drillDown.children.drillId	long	A number identifying a drilldown child record.	8.0.3
result.fields.drillDown.children.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	8.0.3
result.fields.drillDown.isRoot	boolean	Indicates whether or not the drilldown information is at the root.	8.0.3
result.fields.fieldType	string	The type of field.	8.0.3
result.fields.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	8.0.3
result.fields.isReadonly	string	Indicates whether or not the information is read-only.	8.0.3
result.fields.isRequired	string	Indicates whether or not the information is required.	8.0.3
result.fields.maxLength	long	Indicates the maximum number of characters for a custom field or the maximum number of fields in a custom drop-down list.	8.0.3
result.fields.options[]	result.fields.options{}	Contains the fields that define additional data options.	8.0.3
result.fields.options.text	string	The localized display text.	8.0.3
result.fields.options.value	string	The value for the specified parameter.	8.0.3
result.fields.text	string	The localized display text.	8.0.3
result.fields.value	string	The value for the specified parameter.	8.0.3
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	8.0.3
result.text	string	The localized display text.	8.0.3
status	integer	The record status.	8.0.3

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "id": "ADMINORDER-ADMINORDER",
      "text": "ADMINORDER-ADMINORDER",
      "displayOrder": 0,
      "fields": [
        {
          "id": "Hearing Documentation Attached",
          "text": "Hearing Documentation Attached",
          "value": "Yes",
          "isReadonly": "N",
          "fieldType": "Radio(Y/N)",
          "maxLength": 0,
          "isRequired": "N",
          "displayOrder": 4
        },
        {
          "id": "Notices Sent",
          "text": "Notices Sent",
          "value": "No",
          "isReadonly": "N",
          "fieldType": "Radio(Y/N)",
          "maxLength": 0,
          "isRequired": "Y",
          "displayOrder": 2
        }
      ]
    }
  ]
}