diff --git a/history/taskana-simplehistory-rest-spring/src/docs/asciidoc/simplehistory-rest-api.adoc b/history/taskana-simplehistory-rest-spring/src/docs/asciidoc/simplehistory-rest-api.adoc index 43cb8422d..b8be70f52 100644 --- a/history/taskana-simplehistory-rest-spring/src/docs/asciidoc/simplehistory-rest-api.adoc +++ b/history/taskana-simplehistory-rest-spring/src/docs/asciidoc/simplehistory-rest-api.adoc @@ -3,7 +3,13 @@ == Overview This is the REST documentation for http://taskana.pro)[TASKANA]'s simplehistory REST endpoints. -*For all Query Parameters:* whenever a parameter is an array type, several values can be passed by declaring that parameter multiple times. +*For all Query Parameters:* + +Whenever a parameter is an array type, several values can be passed by declaring that parameter multiple times. + +Whenever a parameter is a complex type, the attributes of the value-object can be passed as a json. +For example, a complex parameter with the name "complex-query-param" and attributes "attribute1" and "attribute2" +would be specified in the following way: + +complex-query-param={"attribute1":"value1","attribute2":"value2"} === Hypermedia Support diff --git a/rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc b/rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc index 75cd3e650..8462b3a3e 100644 --- a/rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc +++ b/rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc @@ -4,7 +4,13 @@ This is the REST documentation for http://taskana.pro)[TASKANA] - the world's first open source solution for Enterprise Task Management. -*For all Query Parameters:* whenever a parameter is an array type, several values can be passed by declaring that parameter multiple times. +*For all Query Parameters:* + +Whenever a parameter is an array type, several values can be passed by declaring that parameter multiple times. + +Whenever a parameter is a complex type, the attributes of the value-object can be passed as a json. +For example, a complex parameter with the name "complex-query-param" and attributes "attribute1" and "attribute2" +would be specified in the following way: + +complex-query-param={"attribute1":"value1","attribute2":"value2"} === Hypermedia Support diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryFilterParameter.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryFilterParameter.java index 17eddf379..ce89c62c8 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryFilterParameter.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryFilterParameter.java @@ -708,9 +708,14 @@ public class TaskQueryFilterParameter implements QueryParameter private final String[] ownerNotLike; // endregion // region primaryObjectReference - /** Filter by the primary object reference of the task. This is an exact match. */ - @JsonProperty("object-reference") - private final ObjectReference[] objectReferenceIn; + /** + * Filter by the primary object reference of the task. This is an exact match. "por" is a + * parameter of complex type. Its following attributes from por[].id to por[].value can be + * specified according to the description of complex parameters in the overview, e.g. + * por={"value":"exampleValue"} + */ + @JsonProperty("por") + private final ObjectReference[] primaryObjectReferenceIn; // endregion // region primaryObjectReferenceCompany /** Filter by the company of the primary object reference of the task. This is an exact match. */ @@ -1501,7 +1506,7 @@ public class TaskQueryFilterParameter implements QueryParameter "owner-not", "owner-like", "owner-not-like", - "object-reference", + "por", "por.company", "por-company-not", "por-company-like", @@ -1699,7 +1704,7 @@ public class TaskQueryFilterParameter implements QueryParameter String[] ownerNotIn, String[] ownerLike, String[] ownerNotLike, - ObjectReference[] objectReferenceIn, + ObjectReference[] primaryObjectReferenceIn, String[] porCompanyIn, String[] porCompanyNotIn, String[] porCompanyLike, @@ -1896,7 +1901,7 @@ public class TaskQueryFilterParameter implements QueryParameter this.ownerNotIn = ownerNotIn; this.ownerLike = ownerLike; this.ownerNotLike = ownerNotLike; - this.objectReferenceIn = objectReferenceIn; + this.primaryObjectReferenceIn = primaryObjectReferenceIn; this.porCompanyIn = porCompanyIn; this.porCompanyNotIn = porCompanyNotIn; this.porCompanyLike = porCompanyLike; @@ -2208,7 +2213,7 @@ public class TaskQueryFilterParameter implements QueryParameter .map(this::wrapElementsInLikeStatement) .ifPresent(query::ownerNotLike); - Optional.ofNullable(objectReferenceIn).ifPresent(query::primaryObjectReferenceIn); + Optional.ofNullable(primaryObjectReferenceIn).ifPresent(query::primaryObjectReferenceIn); Optional.ofNullable(porCompanyIn).ifPresent(query::primaryObjectReferenceCompanyIn); Optional.ofNullable(porCompanyNotIn).ifPresent(query::primaryObjectReferenceCompanyNotIn); diff --git a/routing/taskana-routing-rest/src/docs/asciidoc/routing-rest-api.adoc b/routing/taskana-routing-rest/src/docs/asciidoc/routing-rest-api.adoc index 777061695..9d3cb7cf7 100644 --- a/routing/taskana-routing-rest/src/docs/asciidoc/routing-rest-api.adoc +++ b/routing/taskana-routing-rest/src/docs/asciidoc/routing-rest-api.adoc @@ -4,7 +4,14 @@ This is the REST documentation for http://taskana.pro)[TASKANA]'s routing REST endpoints. -*For all Query Parameters:* whenever a parameter is an array type, several values can be passed by declaring that parameter multiple times. +*For all Query Parameters:* + +Whenever a parameter is an array type, several values can be passed by declaring that parameter multiple times. + + +Whenever a parameter is a complex type, the attributes of the value-object can be passed as a json. +For example, a complex parameter with the name "complex-query-param" and attributes "attribute1" and "attribute2" +would be specified in the following way: + +complex-query-param={"attribute1":"value1","attribute2":"value2"} === Hypermedia Support