Skip to content

Commit

Permalink
Adding JobResult to CompleteJobRequest for gRPC (#4808)
Browse files Browse the repository at this point in the history
* docs: adding `JobResult` to `CompleteJobRequest` for gRPC

* style(formatting): casing fixes

* Update gateway-service.md

---------

Co-authored-by: christinaausley <[email protected]>
  • Loading branch information
1 parent e54a2ed commit 09bd942
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/apis-tools/zeebe-api/gateway-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,48 @@ message CompleteJobRequest {
int64 jobKey = 1;
// a JSON document representing the variables in the current task scope
string variables = 2;
// The result of the completed job as determined by the worker.
// This functionality is currently supported only by user task listeners
optional JobResult result = 3;
}
message JobResult{
// Indicates whether the worker denies the work, or explicitly doesn't approve it.
// For example, a user task listener can deny the completion of a user task by setting this flag to true.
// In this example, the completion of a task is represented by a job that the worker can complete as denied.
// As a result, the completion request is rejected and the task remains active.
// Defaults to false.
optional bool denied = 1;
// Attributes that were corrected by the worker.
// The following attributes can be corrected, additional attributes will be ignored:
// * `assignee` - reset by providing an empty string
// * `dueDate` - reset by providing an empty string
// * `followUpDate` - reset by providing an empty string
// * `candidateGroups` - reset by providing an empty list
// * `candidateUsers` - reset by providing an empty list
// * `priority` - minimum 0, maximum 100, default 50
// Omitting any of the attributes will preserve the persisted attribute's value.
optional JobResultCorrections corrections = 2;
}
message JobResultCorrections {
// The assignee of the task.
optional string assignee = 1;
// The due date of the task.
optional string dueDate = 2;
// The follow-up date of the task.
optional string followUpDate = 3;
// The list of candidate users of the task.
optional StringList candidateUsers = 4;
// The list of candidate groups of the task.
optional StringList candidateGroups = 5;
// The priority of the task.
optional int32 priority = 6;
}
message StringList {
// Wrapper around a list of string values.
repeated string values = 1;
}
```

Expand Down

0 comments on commit 09bd942

Please sign in to comment.