LegacyApiActionDefinitionDataModel

JSON representation
{
  "name": string,
  "description": string,
  "script": string,
  "integrationIdentifier": string,
  "scriptResultName": string,
  "dynamicResultsMetadata": [
    {
      object (LegacyApiDynamicResultMetadata)
    }
  ],
  "creator": string,
  "version": number,
  "parameters": [
    {
      object (LegacyApiActionParameter)
    }
  ],
  "timeoutSeconds": string,
  "asyncPollingIntervalInSeconds": string,
  "totalIntervalTimeoutForAsyncInSeconds": string,
  "defaultResultValue": string,
  "integrationInstances": [
    {
      object (LegacyApiIntegrationInstanceDataModel)
    }
  ],
  "id": string,
  "creationTimeUnixTimeInMs": string,
  "modificationTimeUnixTimeInMs": string,
  "additionalProperties": {
    string: string,
    ...
  },
  "isEnabled": boolean,
  "isAsync": boolean,
  "hasJsonResult": boolean,
  "actionWidgetTemplateIdentifier": string
}
Fields
name

string

Output only. The name of the action.

description

string

Output only. The description of the action.

script

string

Output only. The script of the action.

integrationIdentifier

string

Output only. The integration identifier of the action.

scriptResultName

string

Output only. The script result name of the action.

dynamicResultsMetadata[]

object (LegacyApiDynamicResultMetadata)

Output only. The dynamic results metadata of the action.

creator

string

Output only. The creator of the action.

version

number

Output only. The version of the action.

parameters[]

object (LegacyApiActionParameter)

Optional. The parameters of the action.

timeoutSeconds

string (int64 format)

Output only. The timeout seconds of the action.

asyncPollingIntervalInSeconds

string (int64 format)

Output only. The async polling interval in seconds of the action.

totalIntervalTimeoutForAsyncInSeconds

string (int64 format)

Output only. The total interval timeout for async in seconds of the action.

defaultResultValue

string

Output only. The default result value of the action.

integrationInstances[]

object (LegacyApiIntegrationInstanceDataModel)

Output only. The integration instances of the action.

id

string (int64 format)

Output only. The id.

creationTimeUnixTimeInMs

string (int64 format)

Output only. The creation time unix time in ms.

modificationTimeUnixTimeInMs

string (int64 format)

Output only. The modification time unix time in ms.

additionalProperties

map (key: string, value: string)

Output only. The additional properties.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

isEnabled

boolean

Output only. Whether the action is enabled.

isAsync

boolean

Output only. Whether the action is async.

hasJsonResult

boolean

Output only. Whether the action has json result.

actionWidgetTemplateIdentifier

string

Output only. The action widget template identifier of the action.

LegacyApiDynamicResultMetadata

The dynamic results metadata of the action.

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

string

Output only. The result name.

resultExample

string

Output only. The result example.

LegacyApiActionParameter

The action parameter.

JSON representation
{
  "id": string,
  "creationTimeUnixTimeInMs": string,
  "modificationTimeUnixTimeInMs": string,
  "customActionId": string,
  "defaultValue": string,
  "description": string,
  "name": string,
  "value": string,
  "type": enum (CustomActionParameterType),
  "optionalValues": [
    string
  ],
  "isMandatory": boolean
}
Fields
id

string (int64 format)

Output only. The id.

creationTimeUnixTimeInMs

string (int64 format)

Output only. The creation time unix time in ms.

modificationTimeUnixTimeInMs

string (int64 format)

Output only. The modification time unix time in ms.

customActionId

string (int64 format)

Output only. The custom action id.

defaultValue

string

Output only. The default value.

description

string

Output only. The description.

name

string

Output only. The name.

value

string

Output only. The value.

type

enum (CustomActionParameterType)

Output only. The type.

optionalValues[]

string

Output only. The optional values.

isMandatory

boolean

Output only. Whether is mandatory.

CustomActionParameterType

Custom action parameter type.

Enums
STRING String.
BOOLEAN Boolean.
WFS_REPOSITORY Playbooks.
USER_REPOSITORY Users.
STAGES_REPOSITORY Case stages.
CLOSE_CASE_REASON_REPOSITORY Close case reasons.
CLOSE_CASE_ROOTCAUSE_REPOSITORY Close root causes.
PRIORITIES_REPOSITORY Case priorities.
EMAIL_CONTENT Email Content.
CONTENT Content.
PASSWORD Password.
ENTITY_TYPE Entity Type.
MULTI_VALUES Multi Values.
LIST List.
CODE Code.
TIME_SPAN_SECONDS TimeSpanSeconds.
MULTIPLE_CHOICE_PARAMETER MultipleChoiceParameter.

LegacyApiIntegrationInstanceDataModel

The integration instance data model.

JSON representation
{
  "identifier": string,
  "integrationIdentifier": string,
  "environmentIdentifier": string,
  "instanceName": string,
  "instanceDescription": string,
  "isConfigured": boolean,
  "isRemote": boolean,
  "isSystemDefault": boolean
}
Fields
identifier

string

Output only. The identifier.

integrationIdentifier

string

Output only. The integration identifier.

environmentIdentifier

string

Output only. The environment identifier.

instanceName

string

Output only. The instance name.

instanceDescription

string

Output only. The instance description.

isConfigured

boolean

Output only. Whether is configured.

isRemote

boolean

Output only. Whether is remote.

isSystemDefault

boolean

Output only. Whether is system default.