Add an Action Type

post/add/AIT

Creates a new Action Type (Action Item Type – AIT).

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

The type code is AIT.

Action Types can be added or edited via UI: Administration > Configuration > Actions > Action Types

formulaName
string or null <= 255 characters

A name of the Action Item Logic used by this type. See the Action Item Logic documentation.

typedId
string
uniqueName
required
string <= 255 characters

A unique name of the Action Item Type.

configuration
object

Tabs defined as a JSON. Used for configuring dynamicTabs in actions, labels of the tabs etc. See the Detail Page Layout and Dynamic Tabs documentation.

createdBy
integer
lastUpdateDate
string <date-time>
userGroupEdit
string or null <= 255 characters
userGroupViewDetails
string or null <= 255 characters
label
string <= 255 characters
version
integer
createDate
string <date-time>
lastUpdateBy
integer
Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects (ActionItemType)
Array
formulaName
string or null <= 255 characters

A name of the Action Item Logic used by this type. See the Action Item Logic documentation.

typedId
string
uniqueName
required
string <= 255 characters

A unique name of the Action Item Type.

configuration
object

Tabs defined as a JSON. Used for configuring dynamicTabs in actions, labels of the tabs etc. See the Detail Page Layout and Dynamic Tabs documentation.

createdBy
integer
lastUpdateDate
string <date-time>
userGroupEdit
string or null <= 255 characters
userGroupViewDetails
string or null <= 255 characters
label
string <= 255 characters
version
integer
createDate
string <date-time>
lastUpdateBy
integer
status
integer
Request samples
application/json
{
  • "operation": "add",
  • "data": {
    • "configuration": {
      • "name": "Default Actions config",
      • "tabs": [
        • {
          }
        ]
      },
    • "uniqueName": "AITtest",
    • "label": "Action Type Test"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-85969998d5-pkhfz",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "29.AIT",
        • "uniqueName": "AITtest",
        • "label": "Action Type Test",
        • "formulaName": null,
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "configuration": {
          },
        • "createDate": "2023-06-28T08:22:30",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2023-06-28T08:22:30",
        • "lastUpdateBy": 2147490696
        }
      ],
    • "status": 0
    }
}