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

Resource: IntegrationJob

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. This resource describes an Integration Job definition.

JSON representation 
{
  "name": string,
  "displayName": string,
  "script": string,
  "author": string,
  "description": string,
  "version": integer,
  "parameters": [
    {
      object (JobParameter)
    }
  ],
  "integration": string,
  "enabled": boolean,
  "custom": boolean,
  "system": boolean,
  "documentationLink": string
}
Fields
name

string

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

string

Required. Job's description, limited to a maximum of 400 characters.
script

string

Required. Job's script.
author

string

Output only. The user who saved the job.
description

string

Optional. Job's description.
version

integer

Required. Job's version.
parameters[]

object (JobParameter)

Optional. The job's parameters definitions.
integration

string

Output only. Parent integration identifier.
enabled

boolean

Required. Determines whether the job is enabled and instances of its definition can be created.
custom

boolean

Required. Describes whether the job is custom or commercial.
system

boolean

Output only. Determines whether the job is a system job. System jobs are installed during the deployment and are part of the Siemplify integration.

JobParameter

JobParameter describes a job parameter.

JSON representation 
{
  "id": integer,
  "defaultValue": string,
  "displayName": string,
  "description": string,
  "mandatory": boolean,
  "type": enum (ParamType)
}
Fields
id

integer

Required. The parameter's id.
defaultValue

string

Optional. The default value of the parameter.
displayName

string

Required. The parameter display name.
description

string

Required. The parameter's description.
mandatory

boolean

Required. Is parameter mandatory.
type

enum (ParamType)

Required. The parameter's type.

ParamType

ParamType describes a job parameter type.

Enums
BOOLEAN Boolean type.
INT Int type.
STRING String type.
PASSWORD Password type.
IP IP type.
IP_OR_HOST IP or host type.
URL URL type.
DOMAIN Domain type.
EMAIL Email type.
VALUES_LIST Values type.
VALUES_AS_SEMI_COLON_SEPARATED_STRING Values as semi-colon separated string type.
MULTI_VALUES_SELECTION Multi values selection type.
SCRIPT Script type.
FILTER_LIST Filter list type.
NUMERICAL_VALUES Numerical values type.

Methods

create

 Creates a new custom IntegrationJob.

delete

 Deletes a specific custom IntegrationJob.

executeTest

 Executes a test run of a `IntegrationJob's Python script.

fetchTemplate

 Returns a default Python script template for an IntegrationJob.

get

 Gets a single IntegrationJob by its resource name.

list

 Lists all IntegrationJobs defined for a specific integration.

patch

 Updates an existing custom IntegrationJob.