REST Resource: projects.locations.instances.integrations.actions

Resource: IntegrationAction

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. This resource describes an action definition as part of an integration.

JSON representation 
{
  "name": string,
  "displayName": string,
  "script": string,
  "timeoutSeconds": integer,
  "asyncPollingIntervalSeconds": integer,
  "asyncTotalTimeoutSeconds": integer,
  "dynamicResults": [
    {
      object (DynamicResultMetadata)
    }
  ],
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "integration": string,
  "integrationInstances": [
    {
      object (IntegrationInstance)
    }
  ],
  "id": string,
  "description": string,
  "author": string,
  "enabled": boolean,
  "scriptResultName": string,
  "async": boolean,
  "defaultResultValue": string,
  "widgetTemplateIdentifier": string,
  "custom": boolean,
  "hasJsonResult": boolean,
  "dynamicResultsMetadataJson": string
}
Fields
name

string

Identifier. The unique name(ID) of the action. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/actions/{action}
displayName

string

Required. Action's definition name, limited to a maximum of 150 characters.
script

string

Required. Action's script, limited to a maximum size of 5MB.
timeoutSeconds

integer (uint32 format)

Required. Action timeout in seconds. The maximum allowed value is 1200 seconds.
asyncPollingIntervalSeconds

integer (uint32 format)

Optional. The async polling interval time in seconds. The maximum allowed value can not exceed total timeout secs. Relevant only for async actions
asyncTotalTimeoutSeconds

integer (uint32 format)

Optional. The total async polling interval timeout in seconds. The maximum allowed value is 14(days)x24x3600 = 1209600 secs. Relevant only for async actions
dynamicResults[]

object (DynamicResultMetadata)

Optional. List of dynamic results metadata. The max count for the items is 50.
parameters[]

object (ActionParameter)

Optional. Action's parameters. The max count for the items is 50.
integration

string

Output only. The parent integration identifier.
integrationInstances[]

object (IntegrationInstance)

Output only. The integration instances.
id

string (int64 format)

Output only. The action id.
description

string

Optional. Action's description, limited to a maximum or 400 characters.
author

string

Output only. User that created the action in the system.
enabled

boolean

Required. Determines whether the action is enabled or disabled.
scriptResultName

string

Required. The script result name. Describes the field name that holds the script result. Has a maximum character limit of 100 characters.
async

boolean

Required. Determines whether the action is async or not.
defaultResultValue

string

Optional. Action's default result value. Has a maximum character limit of 1000 characters.
widgetTemplateIdentifier

string

Output only. The widget template identifier. Relevant only for actions which contain a widget.
custom

boolean

Output only. Determines whether the action is custom or not.
hasJsonResult

boolean

Output only. Describes whether the action has a json result.
dynamicResultsMetadataJson

string

Output only. The dynamic results metadata json.

DynamicResultMetadata

Dynamic result metadata.

JSON representation 
{
  "resultName": string,
  "resultExample": string,
  "displayResult": boolean
}
Fields
resultName

string

Output only. The result name.
resultExample

string

Optional. The result example. Has a maximum character limit of 100000 characters.
displayResult

boolean

Required. Determines whether to display the result.

ActionParameter

Action parameter object. Action may include parameters that will be filled and during the execution.

JSON representation 
{
  "id": integer,
  "actionId": integer,
  "optionalValues": [
    string
  ],
  "mandatory": boolean,
  "defaultValue": string,
  "displayName": string,
  "type": enum (ActionParamType),
  "description": string
}
Fields
id

integer

Output only. The parameter's id.
actionId

integer

Output only. The action's id.
optionalValues[]

string

Optional. Parameter's optional values. The max count for the items is 50.
mandatory

boolean

Required. Describes whether the parameter is mandatory.
defaultValue

string

Optional. The default value of the parameter. Has a maximum character limit of 150 characters.
displayName

string

Required. The parameter's display name. Has a maximum character limit of 150 characters.
type

enum (ActionParamType)

Required. The parameter's type.
description

string

Required. The parameter's description. Has a maximum character limit of 150 characters.

ActionParamType

Action parameters optional types.

Enums
STRING String type.
BOOLEAN Boolean type.
WFS_REPOSITORY WFS repository type.
USER_REPOSITORY User repository type.
STAGES_REPOSITORY Stages repository type.
CLOSE_CASE_REASON_REPOSITORY Close case reason repository type.
CLOSE_CASE_ROOT_CAUSE_REPOSITORY Close case root cause repository type.
PRIORITIES_REPOSITORY Priorities repository type.
EMAIL_CONTENT Email content type.
CONTENT Content type.
PASSWORD Password type.
ENTITY_TYPE Entity type.
MULTI_VALUES Multi values type.
LIST List type.
CODE Code type.
TIME_SPAN_SECONDS Time span type.
MULTIPLE_CHOICE_PARAMETER Multi choice parameter type.

Methods

create

 CreateIntegrationAction creates a IntegrationAction.

delete

 DeleteIntegrationAction deletes a IntegrationAction.

executeTest

 Executes a test on a action definition script.

fetchActionsByEnvironment

 Fetch actions by environment.

fetchTemplate

 Fetches the default action template, mainly used for obtaining the default script allowing quick start.

get

 GetIntegrationAction gets a IntegrationAction.

list

 ListIntegrationActions lists IntegrationActions.

patch

 UpdateIntegrationAction updates a IntegrationAction.