forked from camunda/camunda-bpm-platform
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(openapi): add historic decision instance endpoints
related to CAM-11558
- Loading branch information
Showing
14 changed files
with
1,040 additions
and
0 deletions.
There are no files selected for viewing
130 changes: 130 additions & 0 deletions
130
...e-rest-openapi/src/main/templates/lib/commons/historic-decision-instance-query-params.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| <#-- Generated From File: camunda-docs-manual/public/reference/rest/filter/get-query/index.html --> | ||
|
|
||
| <#assign sortByValues = [ | ||
| '"evaluationTime"', | ||
| '"tenantId"' | ||
| ]> | ||
|
|
||
| <#assign params = { | ||
| "decisionInstanceId": { | ||
| "type": "string", | ||
| "desc": "Filter by decision instance id." | ||
| }, | ||
| "decisionInstanceIdIn": { | ||
| "type": "array", | ||
| "itemType": "string", | ||
| "desc": "Filter by decision instance ids. Must be a comma-separated list of decision instance ids." | ||
| }, | ||
| "decisionDefinitionId": { | ||
| "type": "string", | ||
| "desc": "Filter by the decision definition the instances belongs to." | ||
| }, | ||
| "decisionDefinitionIdIn": { | ||
| "type": "array", | ||
| "itemType": "string", | ||
| "desc": "Filter by the decision definitions the instances belongs to. Must be a | ||
| comma-separated list of decision definition ids." | ||
| }, | ||
| "decisionDefinitionKey": { | ||
| "type": "string", | ||
| "desc": "Filter by the key of the decision definition the instances belongs to." | ||
| }, | ||
| "decisionDefinitionKeyIn": { | ||
| "type": "array", | ||
| "itemType": "string", | ||
| "desc": "Filter by the keys of the decision definition the instances belongs to. Must be a comma- | ||
| separated list of decision definition keys." | ||
| }, | ||
| "decisionDefinitionName": { | ||
| "type": "string", | ||
| "desc": "Filter by the name of the decision definition the instances belongs to." | ||
| }, | ||
| "decisionDefinitionNameLike": { | ||
| "type": "string", | ||
| "desc": "Filter by the name of the decision definition the instances belongs to, that the parameter | ||
| is a substring of." | ||
| }, | ||
| "processDefinitionId": { | ||
| "type": "string", | ||
| "desc": "Filter by the process definition the instances belongs to." | ||
| }, | ||
| "processDefinitionKey": { | ||
| "type": "string", | ||
| "desc": "Filter by the key of the process definition the instances belongs to." | ||
| }, | ||
| "processInstanceId": { | ||
| "type": "string", | ||
| "desc": "Filter by the process instance the instances belongs to." | ||
| }, | ||
| "caseDefinitionId": { | ||
| "type": "string", | ||
| "desc": "Filter by the case definition the instances belongs to." | ||
| }, | ||
| "caseDefinitionKey": { | ||
| "type": "string", | ||
| "desc": "Filter by the key of the case definition the instances belongs to." | ||
| }, | ||
| "caseInstanceId": { | ||
| "type": "string", | ||
| "desc": "Filter by the case instance the instances belongs to." | ||
| }, | ||
| "activityIdIn": { | ||
| "type": "array", | ||
| "itemType": "string", | ||
| "desc": "Filter by the activity ids the instances belongs to. | ||
| Must be a comma-separated list of acitvity ids." | ||
| }, | ||
| "activityInstanceIdIn": { | ||
| "type": "array", | ||
| "itemType": "string", | ||
| "desc": "Filter by the activity instance ids the instances belongs to. | ||
| Must be a comma-separated list of acitvity instance ids." | ||
| }, | ||
| "tenantIdIn": { | ||
| "type": "array", | ||
| "itemType": "string", | ||
| "desc": "Filter by a comma-separated list of tenant ids. A historic decision instance must have one | ||
| of the given tenant ids." | ||
| }, | ||
| "withoutTenantId": { | ||
| "type": "boolean", | ||
| "desc": "Only include historic decision instances that belong to no tenant. Value may only be | ||
| `true`, as `false` is the default behavior." | ||
| }, | ||
| "evaluatedBefore": { | ||
| "type": "string", | ||
| "format": "date-time", | ||
| "desc": "Restrict to instances that were evaluated before the given date. | ||
| By default*, the date must have the format `yyyy-MM- | ||
| dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`." | ||
| }, | ||
| "evaluatedAfter": { | ||
| "type": "string", | ||
| "format": "date-time", | ||
| "desc": "Restrict to instances that were evaluated after the given date. | ||
| By default*, the date must have the format `yyyy-MM- | ||
| dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`." | ||
| }, | ||
| "userId": { | ||
| "type": "string", | ||
| "desc": "Restrict to instances that were evaluated by the given user." | ||
| }, | ||
| "rootDecisionInstanceId": { | ||
| "type": "string", | ||
| "desc": "Restrict to instances that have a given root decision instance id. | ||
| This also includes the decision instance with the given id." | ||
| }, | ||
| "rootDecisionInstancesOnly": { | ||
| "type": "boolean", | ||
| "desc": "Restrict to instances those are the root decision instance of an evaluation. | ||
| Value may only be `true`, as `false` is the default behavior." | ||
| }, | ||
| "decisionRequirementsDefinitionId": { | ||
| "type": "string", | ||
| "desc": "Filter by the decision requirements definition the instances belongs to." | ||
| }, | ||
| "decisionRequirementsDefinitionKey": { | ||
| "type": "string", | ||
| "desc": "Filter by the key of the decision requirements definition the instances belongs to." | ||
| } | ||
| }> |
23 changes: 23 additions & 0 deletions
23
...openapi/src/main/templates/lib/commons/historic-decision-instance-single-query-params.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <#-- Generated From File: camunda-docs-manual/public/reference/rest/filter/get-query/index.html --> | ||
|
|
||
| <#assign params = { | ||
| "includeInputs": { | ||
| "type": "boolean", | ||
| "desc": "Include input values in the result. | ||
| Value may only be `true`, as `false` is the default behavior." | ||
| }, | ||
| "includeOutputs": { | ||
| "type": "boolean", | ||
| "desc": "Include output values in the result. | ||
| Value may only be `true`, as `false` is the default behavior." | ||
| }, | ||
| "disableBinaryFetching": { | ||
| "type": "boolean", | ||
| "desc": "Disables fetching of byte array input and output values. | ||
| Value may only be `true`, as `false` is the default behavior." | ||
| }, | ||
| "disableCustomObjectDeserialization": { | ||
| "type": "boolean", | ||
| "desc": "Disables deserialization of input and output values that are custom objects. | ||
| Value may only be `true`, as `false` is the default behavior." | ||
| }}> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
...tes/models/org/camunda/bpm/engine/rest/dto/history/DeleteHistoricDecisionInstancesDto.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <#-- Generated From File: camunda-docs-manual/public/reference/rest/history/decision-instance/post-delete/index.html --> | ||
| <#macro dto_macro docsUrl=""> | ||
| <@lib.dto> | ||
|
|
||
| <@lib.property | ||
| name = "historicDecisionInstanceIds" | ||
| type = "array" | ||
| itemType = "string" | ||
| desc = "A list of historic decision instance ids to delete." | ||
| /> | ||
|
|
||
|
|
||
| <@lib.property | ||
| name = "historicDecisionInstanceQuery" | ||
| type = "ref" | ||
| dto = "HistoricDecisionInstanceQueryDto" | ||
| desc = "A historic decision instance query like the request body described by | ||
| [POST /history/decision-instance](${docsUrl}/reference/rest/history/decision-instance/get-decision-instance-query/#query-parameters)." | ||
| /> | ||
|
|
||
|
|
||
| <@lib.property | ||
| name = "deleteReason" | ||
| type = "string" | ||
| desc = "A string with delete reason." | ||
| last = true | ||
| /> | ||
|
|
||
|
|
||
| </@lib.dto> | ||
| </#macro> |
89 changes: 89 additions & 0 deletions
89
...lates/models/org/camunda/bpm/engine/rest/dto/history/HistoricDecisionInputInstanceDto.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| <#-- Generated From File: camunda-docs-manual/public/reference/rest/filter/get-query/index.html --> | ||
| <#macro dto_macro docsUrl=""> | ||
| <@lib.dto > | ||
|
|
||
| <@lib.property | ||
| name = "id" | ||
| type = "string" | ||
| desc = "The id of the decision input value." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "decisionInstanceId" | ||
| type = "string" | ||
| desc = "The id of the decision instance the input value belongs to." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "clauseId" | ||
| type = "string" | ||
| desc = "The id of the clause the input value belongs to." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "clauseName" | ||
| type = "string" | ||
| desc = "The name of the clause the input value belongs to." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "errorMessage" | ||
| type = "string" | ||
| desc = "An error message in case a Java Serialized Object could not be de-serialized." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "type" | ||
| type = "string" | ||
| desc = "The value type of the variable." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "createTime" | ||
| type = "string" | ||
| format = "date-time" | ||
| desc = "The time the variable was inserted. Default format* `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "removalTime" | ||
| type = "string" | ||
| format = "date-time" | ||
| desc = "The time after which the entry should be removed by the History Cleanup job. | ||
| Default format* `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "rootProcessInstanceId" | ||
| type = "string" | ||
| desc = "The process instance id of the root process instance that initiated the process | ||
| containing this entry." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "value" | ||
| type = "object" | ||
| desc = "The variable's value. Value differs depending on the variable's type | ||
| and on the `disableCustomObjectDeserialization` parameter." | ||
| /> | ||
|
|
||
| <@lib.property | ||
| name = "valueInfo" | ||
| type = "object" | ||
| addProperty = "\"additionalProperties\": true" | ||
| desc = "A JSON object containing additional, value-type-dependent | ||
| properties. | ||
|
|
||
| For variables of type `Object`, the following properties are | ||
| returned: | ||
|
|
||
| * `objectTypeName`: A string representation of the object's type | ||
| name. | ||
|
|
||
| * `serializationDataFormat`: The serialization format used to store | ||
| the variable." | ||
| last = true | ||
| /> | ||
|
|
||
| </@lib.dto> | ||
| </#macro> |
Oops, something went wrong.