Form fields retrieval
You can use the flatListOfFields parameter to retrieve a list of
fields from a case. This is helpful when you are building your own user interface and need
to control the look and feel of your application.
The flatListOfFields parameter applies to the following DX APIs:
GET /casetypes/{ID}GET /assignments/{ID}/actions/{actionID}GET /cases/{ID}/actions/{actionID}
Specify the level of detail in the JSON response returned by the DX API by using the following values for the parameter:
- Basic
- Returns basic information about the fields, such as name, value, required fields, and error information. Use this value if you are not displaying the UI to the end users.
- Full
- Returns descriptions of the fields, such as, whether the field is a check box. Use this value if you are displaying the UI to the end users, but are not parsing the unnecessary layout information.
- Empty string
- Returns the complete layout information. This is the default value of the parameter.
The response to the following sample configuration varies for each value of
flatListOfFields:
Basic response
In the following JSON code sample, when the flatListOfFields
parameter is set to Basic, DX API returns the following
information:
- Basic information about the FirstName and DOB fields.
- Basic information about the fields configured in each column of the table as
newRowattribute. - The value of the fields in each row of the table.
{
"view": {
"reference": "",
"validationMessages": "",
"viewID": "GetDetails",
"visible": true,
"name": "Get Details",
"appliesTo": "OWNUFE-OrderApp-Work-CaseB",
"groups": [
{
"field": {
"reference": "FirstName",
"validationMessages": "",
"readOnly": false,
"type": "Text",
"value": "",
"required": false,
"maxLength": 256,
"fieldID": "FirstName",
"validateAs": ""
}
},
{
"field": {
"reference": "DOB",
"validationMessages": "",
"readOnly": false,
"type": "Date Time",
"value": "",
"required": false,
"maxLength": 0,
"fieldID": "DOB",
"validateAs": ""
}
},
{
"groups": [
{
"newRow": {
"listIndex": "{2f832dd100c07986f0453aa5bfb7c12d_listIndex}",
"groups": [
{
"field": {
"reference": "Orders({2f832dd100c07986f0453aa5bfb7c12d_listIndex}).ID",
"validationMessages": "",
"readOnly": false,
"type": "Text",
"value": "",
"required": false,
"maxLength": 256,
"fieldID": "ID",
"validateAs": ""
}
},
{
"field": {
"reference": "Orders({2f832dd100c07986f0453aa5bfb7c12d_listIndex}).OrderType",
"validationMessages": "",
"readOnly": false,
"type": "Text",
"value": "",
"required": false,
"maxLength": 256,
"fieldID": "OrderType",
"validateAs": ""
}
}
],
"testID": "201808091526470952669-R1"
},
"header": {
"title": null
}
},
{
"field": {
"reference": "Orders(1).ID",
"validationMessages": "",
"readOnly": false,
"type": "Text",
"value": "123",
"required": false,
"maxLength": 256,
"fieldID": "ID",
"validateAs": ""
}
},
{
"field": {
"reference": "Orders(1).OrderType",
"validationMessages": "",
"readOnly": false,
"type": "Text",
"value": "TV",
"required": false,
"maxLength": 256,
"fieldID": "OrderType",
"validateAs": ""
}
},
{
"field": {
"reference": "Orders(2).ID",
"validationMessages": "",
"readOnly": false,
"type": "Text",
"value": "345",
"required": false,
"maxLength": 256,
"fieldID": "ID",
"validateAs": ""
}
},
{
"field": {
"reference": "Orders(2).OrderType",
"validationMessages": "",
"readOnly": false,
"type": "Text",
"value": "MObile",
"required": false,
"maxLength": 256,
"fieldID": "OrderType",
"validateAs": ""
}
}
]
}
]
},
"caseID": "OWNUFE-ORDERAPP-WORK C-2001",
"name": "Get Details",
"actionID": "GetDetails"
}Full response
In the following JSON code sample, when the flatListOfFields
parameter is set to Full, the DX API returns the following information:
- Descriptions of the FirstName and DOB fields.
- Descriptions of the fields configured in each column of the table as
newRowattribute. - The value of the fields in each row of the table.
{
"view": {
"reference": "",
"validationMessages": "",
"viewID": "GetDetails",
"visible": true,
"name": "Get Details",
"appliesTo": "OWNUFE-OrderApp-Work-CaseB",
"groups": [
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": true,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "FirstName",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "FirstName",
"labelFormat": "Standard",
"disabled": false,
"testID": "202009210219000018754",
"value": "",
"maxLength": 256,
"expectedLength": "",
"fieldID": "FirstName"
}
},
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": true,
"readOnly": false,
"control": {
"modes": [
{
"dateTime": "auto",
"modeType": "editable",
"controlFormat": "",
"allowTextEntry": true,
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "text",
"specifySize": "auto",
"obfuscated": false,
"displayMode": "calendar",
"minChars": ""
},
{
"modeType": "readOnly",
"dateTimeFormat": "DateTime-Short-YYYY",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "datetime",
"obfuscated": false
}
],
"actionSets": [],
"type": "pxDateTime"
},
"label": "DOB",
"type": "Date Time",
"required": false,
"validateAs": "",
"reference": "DOB",
"labelFormat": "Standard",
"disabled": false,
"testID": "202009210219000063191",
"value": "",
"maxLength": 0,
"expectedLength": "",
"fieldID": "DOB"
}
},
{
"groups": [
{
"newRow": {
"listIndex": "{2f832dd100c07986f0453aa5bfb7c12d_listIndex}",
"groups": [
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "ID",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders({2f832dd100c07986f0453aa5bfb7c12d_listIndex}).ID",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "",
"maxLength": 256,
"expectedLength": "",
"fieldID": "ID"
}
},
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "OrderType",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders({2f832dd100c07986f0453aa5bfb7c12d_listIndex}).OrderType",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "",
"maxLength": 256,
"expectedLength": "",
"fieldID": "OrderType"
}
}
],
"testID": "201808091526470952669-R1"
},
"header": {
"title": null
}
},
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "ID",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders(1).ID",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "123",
"maxLength": 256,
"expectedLength": "",
"fieldID": "ID"
}
},
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "OrderType",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders(1).OrderType",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "TV",
"maxLength": 256,
"expectedLength": "",
"fieldID": "OrderType"
}
},
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "ID",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders(2).ID",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "345",
"maxLength": 256,
"expectedLength": "",
"fieldID": "ID"
}
},
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "OrderType",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders(2).OrderType",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "MObile",
"maxLength": 256,
"expectedLength": "",
"fieldID": "OrderType"
}
}
]
}
]
},
"caseID": "OWNUFE-ORDERAPP-WORK C-2001",
"name": "Get Details",
"actionID": "GetDetails"
}Default response (Empty string)
In the following JSON code sample, when the default value of the
flatListOfFields parameter is not changed, the DX API returns
the following information:
- The complete layout information.
- Descriptions of the fields configured in each column of the table as
newRowattribute. - Row operations and the value of the fields in the row attribute.
{
"view": {
"reference": "",
"validationMessages": "",
"viewID": "GetDetails",
"visible": true,
"name": "Get Details",
"appliesTo": "OWNUFE-OrderApp-Work-CaseB",
"groups": [
{
"layout": {
"visible": true,
"titleFormat": "h2",
"containerFormat": "NOHEADER",
"groups": [
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": true,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "FirstName",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "FirstName",
"labelFormat": "Standard",
"disabled": false,
"testID": "202009210219000018754",
"value": "",
"maxLength": 256,
"expectedLength": "",
"fieldID": "FirstName"
}
},
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": true,
"readOnly": false,
"control": {
"modes": [
{
"dateTime": "auto",
"modeType": "editable",
"controlFormat": "",
"allowTextEntry": true,
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "text",
"specifySize": "auto",
"obfuscated": false,
"displayMode": "calendar",
"minChars": ""
},
{
"modeType": "readOnly",
"dateTimeFormat": "DateTime-Short-YYYY",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "datetime",
"obfuscated": false
}
],
"actionSets": [],
"type": "pxDateTime"
},
"label": "DOB",
"type": "Date Time",
"required": false,
"validateAs": "",
"reference": "DOB",
"labelFormat": "Standard",
"disabled": false,
"testID": "202009210219000063191",
"value": "",
"maxLength": 0,
"expectedLength": "",
"fieldID": "DOB"
}
},
{
"layout": {
"newRow": {
"listIndex": "{2f832dd100c07986f0453aa5bfb7c12d_listIndex}",
"groups": [
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "ID",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders({2f832dd100c07986f0453aa5bfb7c12d_listIndex}).ID",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "",
"maxLength": 256,
"expectedLength": "",
"fieldID": "ID"
}
},
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "OrderType",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders({2f832dd100c07986f0453aa5bfb7c12d_listIndex}).OrderType",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "",
"maxLength": 256,
"expectedLength": "",
"fieldID": "OrderType"
}
}
],
"testID": "201808091526470952669-R1"
},
"repeatContainerFormat": "Nested",
"repeatRowOperations": {
"rowEditing": "row",
"editingInlineType": "readWrite"
},
"fieldListID": ".Orders",
"referenceType": "List",
"readOnly": false,
"title": "Orders",
"rows": [
{
"groups": [
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "ID",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders(1).ID",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "123",
"maxLength": 256,
"expectedLength": "",
"fieldID": "ID"
}
},
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "OrderType",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders(1).OrderType",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "TV",
"maxLength": 256,
"expectedLength": "",
"fieldID": "OrderType"
}
}
],
"testID": "201808091526470952669-R1"
},
{
"groups": [
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "ID",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders(2).ID",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "345",
"maxLength": 256,
"expectedLength": "",
"fieldID": "ID"
}
},
{
"field": {
"validationMessages": "",
"visible": true,
"labelReserveSpace": false,
"readOnly": false,
"control": {
"modes": [
{
"modeType": "editable",
"controlFormat": "Standard",
"textAlign": "Left",
"tooltip": "",
"maxChars": "",
"formatType": "none",
"specifySize": "auto",
"minChars": ""
},
{
"modeType": "readOnly",
"tooltip": "",
"showReadOnlyValidation": "false",
"formatType": "none"
}
],
"actionSets": [],
"type": "pxTextInput"
},
"label": "OrderType",
"type": "Text",
"required": false,
"validateAs": "",
"reference": "Orders(2).OrderType",
"labelFormat": "Standard",
"disabled": false,
"testID": "20180810102741021417525",
"value": "MObile",
"maxLength": 256,
"expectedLength": "",
"fieldID": "OrderType"
}
}
],
"testID": "201808091526470952669-R2"
}
],
"reference": "Orders",
"repeatLayoutFormat": "default",
"sourceType": "Property",
"header": {
"groups": [
{
"caption": {
"columnImportance": "secondary",
"captionFor": "ID",
"columnWidth": "197",
"control": {
"format": "Standard",
"testID": "20180810102741021215240"
},
"value": "ID",
"columnWidthUnit": ""
}
},
{
"caption": {
"columnImportance": "secondary",
"captionFor": "OrderType",
"columnWidth": "197",
"control": {
"format": "Standard",
"testID": "20180810102741021215240"
},
"value": "OrderType",
"columnWidthUnit": ""
}
}
]
},
"testID": "201808091526470952669",
"groupFormat": "Grid",
"layoutFormat": "REPEATINGROW"
}
}
],
"groupFormat": "Stacked",
"layoutFormat": "SIMPLELAYOUT",
"title": ""
}
}
]
},
"caseID": "OWNUFE-ORDERAPP-WORK C-2001",
"name": "Get Details",
"actionID": "GetDetails"
}Previous topic Calling sequences for DX API endpoints Next topic Creating custom screens with the DX API