Actions

patch

https://app.financekey.com/OData/Actions({key})

Defines a process that can be executed in the application.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

method

string

required

length ≥ 1

The method that will be called on the specified Business Object when the Action is executed.

name

string

required

length between 1 and 450

Unique Name for the Action

caption

string

required

length ≥ 1

The Caption field in the Action table is of data type nvarchar and can be used to store a short descriptive string of text related to the particular Action or record. This field can be used to quickly summarize or offer further clarification about the record.

comment

string | null

Miscellaneous notes and information for the entry or record.

entityId

string | null

The entity associated with the action. The value will be null for actions which are generic.

requestTypeId

string | null

The request type for the action

actionConditionId

string

required

length between 1 and 64

Condition that should be applied tprior to executing the action.

notify

boolean

An indicator of if a notification should be generated or not after the action is executed.

description

string

required

length between 1 and 450

The Description of the Action field is an nvarchar data type that allows up to 450 characters to be stored. This field can be used to store a text description of the Action record in the table.

panelId

int32 | null

The PanelId field in the Action table is an integer data type used to identify a specific panel or group related to the action being taken. This field helps to differentiate different panels within the same action type.

actionTypeId

string

required

length between 1 and 16

The ActionTypeId field of the Action table is an nvarchar data type with a maximum length of 16. This field stores an alphanumeric identifier associated with a particular type of action that a user has taken.

redirect

boolean

The Redirect field of data type bit in the Action table is used to indicate whether a user should be redirected to another page after completing an action. A value of '1' indicates that the user should be redirected and a value of '0' indicates that the user should not be redirected.

executionStrategyId

string | null

ExecutionStrategyId is a field of type nvarchar used in the Action table. It contains a unique identifier for each particular execution strategy associated with an action.

logRetentionDays

int32

LogRetentionDays is an int field in the Action table which determines how many days the system should retain the log records associated with this action. This field allows users to specify the required storage period for the logs and provides a flexible approach to managing server log records for improved performance.

mfa

boolean

MFA is a boolean field in the Action table indicating whether multifactor authentication has been performed or not. A value of 0 means no MFA has been done, and a value of 1 means MFA has been done.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!