Execute a Logic

post/actionitem.execute/{TypeCode}

Executes a logic for the specified Action Item and returns the result.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
TypeCode
required
string

The typeCode of the Action Item you want to execute the calculation for.

Example: 23.AI
Request Body schema: application/json
object
Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects
Array
resultName
string
resultLabel
string
result
object or null
excludeFromExport
boolean
warnings
string or null
alertMessage
string or null
alertType
string or null
displayOptions
integer
formatType
string or null
suffix
string or null
resultType
string
cssProperties
string or null
userGroup
string or null
resultGroup
string or null
overrideValueOptions
string or null
overrideAllowEmpty
boolean
labelTranslations
string or null
overridable
boolean
overridden
boolean
resultDescription
string or null
status
integer
Request samples
application/json
{ }
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend",
    • "data": [
      • {
        • "resultName": "DetectionRules",
        • "resultLabel": "Detection Rules",
        • "result": null,
        • "excludeFromExport": false,
        • "warnings": null,
        • "alertMessage": null,
        • "alertType": null,
        • "displayOptions": 16,
        • "formatType": null,
        • "suffix": null,
        • "resultType": "SIMPLE",
        • "cssProperties": null,
        • "userGroup": null,
        • "resultGroup": null,
        • "overrideValueOptions": null,
        • "overrideAllowEmpty": true,
        • "labelTranslations": null,
        • "overridable": false,
        • "overridden": false,
        • "resultDescription": null
        },
      • {
        • "resultName": "DetectedInsight",
        • "resultLabel": "Detected Insight",
        • "result": {
          },
        • "excludeFromExport": false,
        • "warnings": null,
        • "alertMessage": null,
        • "alertType": null,
        • "displayOptions": 16,
        • "formatType": null,
        • "suffix": null,
        • "resultType": "MATRIX",
        • "cssProperties": null,
        • "userGroup": null,
        • "resultGroup": null,
        • "overrideValueOptions": null,
        • "overrideAllowEmpty": true,
        • "labelTranslations": null,
        • "overridable": false,
        • "overridden": false,
        • "resultDescription": null
        }
      ],
    • "status": 0
    }
}