✨ [REST API] Added parameter to API search for terminated and running executions #4187
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A user may want to search for Terminated and/or Running executions without knowing the implementation detail that:
A jobExecution is running if endDate is undefined
A jobExecution is terminated if endDate is defined
Moreover the GET /{scopeId}/jobs/{jobId}/executions API does not have the capability to express a condition like ‘endDate is undefined’. Even with the trick of the endDate a user should first retrieve all the executions and then scan them one by one to decide the status based on the endDate.
To overcome this limitations, I wanted to introduce a new parameter in the REST API:
status
that can take the value of TERMINATED or RUNNING
The status should be represented in the returned model object otherwise the UI or the user is still unable to determine the status without knowing the implementation detail. At this stage there’s no need to persist the status in the DB, it can be a transient field.