Action APIs

Get Account Create Actions (GET)

Returns available actions for creating new accounts.

Route

URI	/api/v1/Actions/CreateActions
Method	GET
Result	JSON – ScenarioActionDefinition

Parameters

Response Structure ScenarioActionDefinition[] containing:

• ActionId: Uniquely refers to the supported action.

• Label: string value

• Description: string value

• TypeId: References a <see cref="WellKnownTypeIds"/> to indicate an icon for this action

• TargetObjectDisplayNameProperty: string value

• IsWithoutComment: Indicates if this action does not require a comment to be entered.

• IsDirectExecutable: Indicates if this action does not require an selected elements and can be executed directly.

• ActionParameterPropertyNames: string[] value

• NumberOfSteps: int value

• IsForInfoOnly: Indicates if this action is only for displaying information and cannot be executed.

Example

GET http://localhost/api/v1/Actions/CreateActions

Example Response

  {
    "actionId": "123e4567-e89b-12d3-a456-426614174000",
    "label": "sample",
    "description": "sample",
    "typeId": "sample",
    "targetObjectDisplayNameProperty": "sample",
    "isWithoutComment": true,
    "isDirectExecutable": true,
    "actionParameterPropertyNames": {},
    "numberOfSteps": 1,
    "isForInfoOnly": true
  }

Execute Action (PUT)

Creates a new instance of <see cref="ResourcesController"/> with the given parameters.

Route

URI	/api/v1/actions/{actionId}
Method	PUT
Result	JSON – IActionResponse

Request Payload

Property	Type	Mandatory	Description
CurrentContext	ResourceTreeItemModel	No
SelectedEntries	ResourceTreeItemModel[]	No
FormJsonString	string	No
Comment	string	No
Action	striing	Yes	Action-specific parameter values

Response Structure

ActionExecutionResult containing:

• Success: Boolean indicating if action executed successfully

• Message: Result message

• Data: Action-specific result data

• Errors: List of errors if any

Example Request

PUT http://localhost/api/v1/actions/{actionId}
Content-Type: application/json

{
  "CurrentContext": {}
  "SelectedEntries": {},
  "FormJsonString": "sample",
  "Comment": "sample"
   "action"
   
}

Example Response

{
  "Success": true,
  "Message": "Action executed successfully",
  "Data": {
    "UserId": "123e4567-e89b-12d3-a456-426614174000",
    "Status": "Created"
  },
  "Errors": []
}

Execute Action (PUT)

Creates a new instance of <see cref="ResourcesController"/> with the given parameters.

Route

URI	/api/v1/actions/{actionId}
Method	PUT
Result	JSON – IActionResponse

Request Payload

ActionRequest object:

Property	Type	Mandatory	Description
CurrentContext	ResourceTreeItemModel	No
SelectedEntries	ResourceTreeItemModel[]	No
FormJsonString	string	No
Comment	string	No
action	string	Yes

Example

PUT http://localhost/api/v1/actions/{actionId} Content-Type: application/json  

{     "CurrentContext": {},     
      "SelectedEntries": {},     
      "FormJsonString": "sample",     
      "Comment": "sample",     
      "action": "sample" 
}

Get Account Actions (POST)

Returns all available actions for given accounts as grid entries

Route

URI	/api/v1/actions/AccountActions
Method	POST
Result	JSON – AccountActionModel[]

Parameters

None

Response Structure Returns AccountActionModel[] object containing:

- SupportedActions: ScenarioActionDefinitionModel[] value

Example

POST http://localhost/api/v1/actions/AccountActions

Example Response

{     "SupportedActions": {} }

Get Create Actions (GET)

Returns all available actions for given accounts as grid entries

Route

URI	/api/v1/actions/CreateActions
Method	GET
Result	JSON – ScenarioActionDefinition[]

Parameters

None

Response Structure Returns ScenarioActionDefinition[] object containing:

- ActionId: Uniquely refers to the supported action.

- Label: string value

- Description: string value

- TypeId: References a <see cref="WellKnownTypeIds"/> to indicate an icon for this action

- TargetObjectDisplayNameProperty: string value

- IsWithoutComment: Indicates if this action does not require a comment to be entered.

- IsDirectExecutable: Indicates if this action does not require an selected elements and can be executed directly.

- ActionParameterPropertyNames: string[] value

- NumberOfSteps: int value

- IsForInfoOnly: Indicates if this action is only for displaying information and cannot be executed.

Example

GET http://localhost/api/v1/actions/CreateActions

Example Response

{     
      "ActionId": "123e4567-e89b-12d3-a456-426614174000",
      "Label": "sample",     
      "Description": "sample",     
      "TypeId": 1,
      "TargetObjectDisplayNameProperty": "sample",     
      "IsWithoutComment": true,     
      "IsDirectExecutable": true,     
      "ActionParameterPropertyNames": {},     
      "NumberOfSteps": 1,     
      "IsForInfoOnly": true 
}