Create an Action Item

post/add/AI

Adds an Action Item.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
required
object (ActionItem)

The type code is AI.

lastUpdateByName
string or null <= 255 characters
Array of objects
Array
resultName
string
resultLabel
string
result
object
excludeFromExport
boolean
warnings
Array of strings
alertMessage
string
alertType
string
Possible values: "CRITICAL" "RED" "YELLOW"
displayOptions
integer
formatType
string
Possible values: "NUMERIC" "NUMERIC_LONG" "MONEY" "PERCENT" "TEXT" "MONEY_EUR" "MONEY_USD" "MONEY_GBP" "MONEY_JPY" "MONEY_CHF" "MONEY_PLN" "DATETIME" "DATE" "INTEGER" "LINK" "COMPLEX" "SPARKLINE"
suffix
string
resultType
string
cssProperties
string
userGroup
string
resultGroup
string
overrideValueOptions
Array of any
overrideAllowEmpty
boolean
labelTranslations
string
overridable
boolean
overridden
boolean
resultDescription
string
createdByName
string or null <= 255 characters
typedId
string
assignedToName
string <= 255 characters
lastUpdateDate
string <date-time>
dueDate
string <date-time>
actionItemType
required
string
description
string or null
parentTabName
string or null <= 255 characters
assignedTo
required
integer
assignedToGroup
string or null <= 255 characters
sourceContext
string or null <= 255 characters
targetContext
string or null <= 255 characters
parentTypedId
string or null <= 255 characters
completedByName
string or null <= 255 characters
createDate
string <date-time>
summary
required
string <= 255 characters
originatorTypedId
string or null <= 255 characters
version
integer
completedDate
string or null <date-time>
uniqueName
string <= 255 characters
createdBy
integer
completedBy
integer or null
status
string <= 255 characters
Possible values: "OPEN" "DONE" "REJECTED" "BLOCKED" "POSTPONED"
lastUpdateBy
integer
Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects (ActionItem)
Array
lastUpdateByName
string or null <= 255 characters
Array of objects
createdByName
string or null <= 255 characters
typedId
string
assignedToName
string <= 255 characters
lastUpdateDate
string <date-time>
dueDate
string <date-time>
actionItemType
required
string
description
string or null
parentTabName
string or null <= 255 characters
assignedTo
required
integer
assignedToGroup
string or null <= 255 characters
sourceContext
string or null <= 255 characters
targetContext
string or null <= 255 characters
parentTypedId
string or null <= 255 characters
completedByName
string or null <= 255 characters
createDate
string <date-time>
summary
required
string <= 255 characters
originatorTypedId
string or null <= 255 characters
version
integer
completedDate
string or null <date-time>
uniqueName
string <= 255 characters
createdBy
integer
completedBy
integer or null
status
string <= 255 characters
Possible values: "OPEN" "DONE" "REJECTED" "BLOCKED" "POSTPONED"
lastUpdateBy
integer
status
integer
Request samples
application/json
{
  • "data": {
    • "summary": "Important Action",
    • "assignedTo": 2147490696,
    • "dueDate": "2023-06-30T00:00:00",
    • "description": "This action is really important!",
    • "actionItemType": "__DEFAULT__",
    • "parentTypedId": null
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "lastUpdateByName": "string",
        • "outputs": [
          ],
        • "createdByName": "string",
        • "typedId": "string",
        • "assignedToName": "string",
        • "lastUpdateDate": "2019-08-24T14:15:22Z",
        • "dueDate": "2019-08-24T14:15:22Z",
        • "actionItemType": "string",
        • "description": "string",
        • "parentTabName": "string",
        • "assignedTo": 0,
        • "assignedToGroup": "string",
        • "sourceContext": "string",
        • "targetContext": "string",
        • "parentTypedId": "string",
        • "completedByName": "string",
        • "createDate": "2019-08-24T14:15:22Z",
        • "summary": "string",
        • "originatorTypedId": "string",
        • "version": 0,
        • "completedDate": "2019-08-24T14:15:22Z",
        • "uniqueName": "string",
        • "createdBy": 0,
        • "completedBy": 0,
        • "status": "OPEN",
        • "lastUpdateBy": 0
        }
      ],
    • "status": 0
    }
}