StartSubmitToProject

Starts a submit to a specified project.

Parameters

Name Type Description
startsubmittoproject Function

Starts a submit to a specified project. 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.

project
  • ID (integer)
  • UUID (string)
  • internalname (string)

The project 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/startsubmittoproject/UBG_ISSUES.ANIMATION_PRO

Post data:

{fixedFields: false, includeNotes: true, 
fields: [{dbname:"TITLE"}, {dbname: "REPRODUCIBLE_"}]}

Response:

{
  "startSubmitToProject": {
    "transition": {
      "id": 3,
      "name": "Submit",
      "uuid": "a78f0a30-1305-46c2-b661-df8219c105b2",
      "type": "regular",
      "isQuick": false,
      "noteRequired": false,
      "urlRequired": false,
      "fileRequired": false,
      "itemRequired": false
    },
    "item": {
      "table": {
        "id": 1000,
        "uuid": "dc8cd329-b430-436f-bb75-bf90008e6a50",
        "name": "Issues",
        "dbName": "UBG_ISSUES"
      },
      "fieldMetadata": [
        {
          "id": 54,
          "name": "Title",
          "dbname": "TITLE",
          "syscode": 4,
          "type": "text",
          "required": true,
          "readonly": false,
          "renderHtml": false,
          "sectionId": 1,
          "helpText": "",
          "password": false,
          "maxLength": 80
        },
        {
          "id": 70,
          "name": "Reproducible",
          "dbname": "REPRODUCIBLE_",
          "syscode": 0,
          "type": "binary",
          "required": false,
          "readonly": false,
          "renderHtml": false,
          "sectionId": 2,
          "helpText": "",
          "selections": [
            {
              "id": 0,
              "name": "No"
            },
            {
              "id": 1,
              "name": "Yes"
            }
          ]
        }
      ],
      "fields": {
        "TITLE": {
          "value": ""
        },
        "REPRODUCIBLE_": {
          "id": 0,
          "name": "No"
        }
      },
      "notes": []
    }
  },
  "result": {
    "type": "OK",
    "msg": ""
  }
}

Comments

None.