ActivateJobsRequest

Loading ....

Source:

{
  "$id": "io.miranum.bpmn.command.v1.ActivateJobsRequest",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "type": {
      "description": "the job type, as defined in the BPMN process",
      "type": "string"
    },
    "worker": {
      "description": "the name of the worker activating the jobs, mostly used for logging purposes",
      "type": "string"
    },
    "timeout": {
      "description": "a job returned after this call will not be activated by another call until the\ntimeout (in ms) has been reached",
      "type": "number"
    },
    "maxJobsToActivate": {
      "description": "the maximum jobs to activate by this request",
      "type": "number"
    },
    "fetchVariable": {
      "description": "a list of variables to fetch as the job variables; if empty, all visible variables at\nthe time of activation for the scope of the job will be returned",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "requestTimeout": {
      "description": "The request will be completed when at least one job is activated or after the requestTimeout (in ms).\nif the requestTimeout = 0, a default timeout is used.\nif the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.",
      "type": "number"
    }
  }
}