FinishTransition

Completes a transition on an item.

The specified item will get a recordlock if the table uses record-locking. This record-lock is passed to the FinishTransition call.

Parameters

Name	Type	Description
`FinishTransition`	Function	Completes a transition on an item. You can send new field values with the post data using the `transition` object.
`table`	`ID` (integer) `UUID` (string) `dbname` (string) `name` (string)	The table identifier.
`item`	`ID` (integer) `UUID` (string)	The item identifier.
`transition`	`ID` (integer) `UUID` (string) `internal name` (string)	The transition identifier to use. If 0, a valid Update transition is used (if found). Tip: Run GetItemTransitions first to determine the transition identifier that you will specify. Not all transitions have an internal name. Those that do return the internal name as `dbname` in the GetItemTransitions response.
`record-lock ID`	`ID` (integer)	Use one of the following: The ID value from the StartTransition response 0 if the table does not use record locking -1 if you did not invoke StartTransition and you want to run the transition without first getting the current field values of the item.

Post Data

Name	Type	Description
`itemOptions` (optional)	ItemOptions	Used to define the item's values that will be included in the response if the transition succeeds. When `itemOptions` are included, only the specified fields are sent in the response.
`breakLock` (optional)	boolean	Allows the JSON API to steal the record lock from any user who might have one on this item, so that this call should not fail due to a user having the record locked. However, this causes any user who has a transition form open on this item to get an error when he or she tries to commit the transition.
`transition` (optional)	object	Use the `transition` object to provide new field values for the transition. Only provide values for fields you want to change.

Name

Type

Description

itemOptions

(optional)

ItemOptions

Used to define the item's values that will be included in the response if the transition succeeds.

When itemOptions are included, only the specified fields are sent in the response.

breakLock

(optional)

boolean

Allows the JSON API to steal the record lock from any user who might have one on this item, so that this call should not fail due to a user having the record locked. However, this causes any user who has a transition form open on this item to get an error when he or she tries to commit the transition.

transition

(optional)

object

Use the transition object to provide new field values for the transition. Only provide values for fields you want to change.

Example

URL:

http://AEserverName/jsonapi/finishTransition/1000/3/18/-1

Post data:

{fixedFields: false, fields: [{dbname: "STATUS_LOG"}, {dbname: "TESTER"}], 
→transition: {"STATUS_LOG": "Reopen issue", "TESTER": "7"}}

Response:

{
  "item": {
    "id": {
      "id": 3,
      "uuid": "c2379ef5-6f2d-4e21-924f-5c2aa2a0382e",
      "itemIdPrefixed": "ENH000005",
      "itemId": "000005",
      "url": "http://AEserverName:80/tmtrack/tmtrack.dll?...Template=view&TableId=1000"
    },
    "table": {
      "id": 1000,
      "uuid": "dc8cd329-b430-436f-bb75-bf90008e6a50",
      "name": "Issues",
      "dbName": "UBG_ISSUES"
    },
    "fieldMetadata": [
      {
        "id": 65,
        "name": "Status Log",
        "dbname": "STATUS_LOG",
        "syscode": 0,
        "type": "journal",
        "renderHtml": false,
        "appendOnly": true,
        "sortNewestFirst": false
      },
      {
        "id": 63,
        "name": "Tester",
        "dbname": "TESTER",
        "syscode": 0,
        "type": "user",
        "renderHtml": false,
        "isMultiSelect": false
      }
    ],
    "fields": {
      "STATUS_LOG": {
        "value": "07/13/2016 03:49:48 PM  -  Bill Admin:\r\n\nReopen issue\r\n"
      },
      "TESTER": {
        "id": 3,
        "name": "Chris Tester"
      }
    }
  },
  "result": {
    "type": "OK",
    "msg": ""
  }
}

Comments

None.