Operations on actions.
Use this when a user needs to create, read or list actions for a transaction.
Actions:
- read: Reads a single action of a transaction with full details.
args(dict):
workspace_id (int): Mandatory. The id of the workspace.
transaction_id (int): Mandatory. The id of the transaction.
action_id (int): Mandatory. The id of the action to read.
- list: Lists all actions of a transaction (minimal info).
args(dict):
workspace_id (int): Mandatory. The id of the workspace.
transaction_id (int): Mandatory. The id of the transaction.
sort (str): Optional. Field to sort the actions by.
- create_http_call: Creates an http call action for transaction. This action is executed synchronously.
args(dict): Dictionary with the following required parameters:
action_name (str): Mandatory. The name of the action.
workspace_id (int): Mandatory. The id of the workspace to list services from.
transaction_id (int): Mandatory. The id of the transaction.
action (WebAction): Mandatory. The action definition. See WebAction schema below.
- create_web_hook: Creates a web hook action for transaction. This action is executed asynchronously.
args(dict): Dictionary with the following required parameters:
action_name (str): Mandatory. The name of the action.
workspace_id (int): Mandatory. The id of the workspace to list services from.
transaction_id (int): Mandatory. The id of the transaction.
action (WebAction): Mandatory. The action definition. See WebAction schema below.
- assign_keystore: Assign keystore asset to the action.
args(dict):
id (int): Mandatory. The id of the action.
transaction_id (int): Mandatory. The id of the transaction.
asset_id (int): Mandatory. The id of the keystore asset to assign.
alias (str): Mandatory. The certificate alias to use.
workspace_id (int): Mandatory. The id of the workspace.
- assign_certificate: Assign certificate asset to the action.
args(dict):
id (int): Mandatory. The id of the action.
transaction_id (int): Mandatory. The id of the transaction.
asset_id (int): Mandatory. The id of the certificate asset to assign.
workspace_id (int): Mandatory. The id of the workspace.
Action Schema:
{'$defs': {'HttpHeader': {'additionalProperties': True, 'properties': {'name': {'description': 'HTTP header name', 'title': 'Name', 'type': 'string'}, 'value': {'description': 'HTTP header value', 'title': 'Value', 'type': 'string'}}, 'required': ['name', 'value'], 'title': 'HttpHeader', 'type': 'object'}, 'QueryParameter': {'additionalProperties': True, 'properties': {'name': {'description': 'Query parameter name', 'title': 'Name', 'type': 'string'}, 'value': {'description': 'Query parameter value', 'title': 'Value', 'type': 'string'}}, 'required': ['name', 'value'], 'title': 'QueryParameter', 'type': 'object'}}, 'properties': {'urlValue': {'description': 'Action request url value', 'title': 'Urlvalue', 'type': 'string'}, 'urlMethod': {'description': "Action request HTTP method of the request for the transaction request matching. Uppercase, e.g., 'GET', 'POST'", 'title': 'Urlmethod', 'type': 'string'}, 'bodyContent': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Action request body content', 'title': 'Bodycontent'}, 'queryParameters': {'anyOf': [{'items': {'$ref': '#/$defs/QueryParameter'}, 'type': 'array'}, {'type': 'null'}], 'default': [], 'description': 'List of query parameters', 'title': 'Queryparameters'}, 'headers': {'anyOf': [{'items': {'$ref': '#/$defs/HttpHeader'}, 'type': 'array'}, {'type': 'null'}], 'default': [], 'description': 'List of response headers', 'title': 'Headers'}}, 'required': ['urlValue', 'urlMethod', 'bodyContent'], 'title': 'WebAction', 'type': 'object'}