StartSubmitToAux

Starts a submit to a specified auxiliary table.

Parameters

Name	Type	Description
startsubmittoaux	Function	Starts a submit to a specified auxiliary table. The main purpose of this function is to get the item's current field values, as well as information about which fields are required or read-only.
table	ID (integer) UUID (string) internalname (string) name (string)	The table identifier.

Post Data

Name	Type	Description
itemOptions (optional)	ItemOptions	Use itemOptions to limit the response data. When itemOptions are not included, all fields are sent in the response. When itemOptions are included, only the specified fields, plus fields required by the transition, are sent in the response.

Example

URL:

http://AEserverName/jsonapi/startsubmittoaux/UBG_IDM_CONFIGURATIONS

Post data:

{fixedFields: false, fields: [{dbname:"TITLE"}, {dbname: "FIELD_NAME"}]}

Response:

{
  "startSubmitToAux": {
    "item": {
      "table": {
        "id": 1004,
        "uuid": "dcfead12-5fa4-471d-af37-7f9a36dee2c3",
        "name": "IDM Configurations",
        "dbName": "UBG_IDM_CONFIGURATIONS"
      },
      "fieldMetadata": [
        {
          "id": 152,
          "name": "Application",
          "dbname": "TITLE",
          "syscode": 4,
          "type": "text",
          "required": true,
          "readonly": false,
          "renderHtml": false,
          "sectionId": 1,
          "helpText": "Name of the application the configuration record pertains to",
          "password": false,
          "maxLength": 80
        },
        {
          "id": 153,
          "name": "Field Name",
          "dbname": "FIELD_NAME",
          "syscode": 0,
          "type": "text",
          "required": true,
          "readonly": false,
          "renderHtml": false,
          "sectionId": 1,
          "helpText": "The field name of the configuration data",
          "password": false,
          "maxLength": 80
        }
      ],
      "fields": {
        "TITLE": {
          "value": ""
        },
        "FIELD_NAME": {
          "value": ""
        }
      }
    }
  },
  "result": {
    "type": "OK",
    "msg": ""
  }
}

Comments

None.