Skip to main content

Run Job Trigger

POST 
/runJobTrigger

This API call can be used to run a job trigger in SSM. The following cases illustrate different scenarios on the usage of the analyticsAdvanceQuery parameter in the API: Case 1: When you configure the "analyticsAdvanceQuery" within the payload, set the "defaultActionForAnalytics" as "true", and then execute the control from the API, it overrides the default action and the advanced query configuration within the job trigger. Case 2: When you configure the "analyticsAdvanceQuery" within the payload, set the "defaultActionForAnalytics" as "false", and then execute the control from the API without performing the default actions configured in the control, it overrides the default action and the advanced query configuration within the job trigger. Case 3: When you do not configure both the "analyticsAdvanceQuery" and the "defaultActionForAnalytics", the default action will depend on the configuration provided in the analytics job trigger. The following cases illustrate different scenarios on the usage of the analyticsCategories parameter in the API: Case 1: When you set the "defaultActionForAnalytics" as "true" to perform default actions for analytics controls by executing the control from job API, it will override the default action configuration within the job trigger. Case 2: When you set the "defaultActionForAnalytics" as "false" to not perform default actions for analytics controls by executing the control from job API, it will override the default action configuration within the job trigger. Case 3: When the defaultActionForAnalytics parameter is not set in the payload, the default action will depend on the configuration provided in the analytics job trigger. The Authorization must have Bearer followed by Token. Mandatory params: jobname triggername jobgroup Optional params: valueMap createJobIfDoesNotExist - true/false

Request​

Body

    analyticsCategories string
    defaultActionForAnalytics string
    jobgroup string
    jobname string
    triggername string

Responses​

Run Job Trigger / Runjobtrigger - class name package / Run Job Trigger - defaultActionForAnalytics set as true / Run Job Trigger - default action for analytics set as false in payload / Run Job Trigger - Not configuring "analyticsAdvanceQuery" and "defaultActionForAnalytics" / Analytics categories with default action set as true / Analytics categories with default action set as false / Analytics categories without adding default action for analytics

Response Headers

  • Access-Control-Allow-Credentials

    string

  • Access-Control-Allow-Origin

    string

  • Cache-Control

    string

  • Date

    string

  • Expires

    string

  • Permissions-Policy

    string

  • Referrer-Policy

    string

  • Set-Cookie

    string

  • Strict-Transport-Security

    string

  • X-Content-Type-Options

    string

Schema

    errorCode string
    msg string
    timestamp string
Loading...