This parameter can't be used together with 'custom-int-1-within'.
*/
+ @Schema(
+ name = "custom-int-1-from",
+ description =
+ "Filter by lower bound of customInt1. This parameter can't be used together with "
+ + "'custom-int-1-within'.")
@JsonProperty("custom-int-1-from")
private final Integer customInt1From;
/** Exclude values from a lower bound of the field customInt1 of the Task. */
+ @Schema(
+ name = "custom-int-1-from-not",
+ description = "Exclude values from a lower bound of the field customInt1 of the Task.")
@JsonProperty("custom-int-1-from-not")
private final Integer customInt1FromNot;
/**
@@ -46,24 +323,45 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-1-within'.
*/
+ @Schema(
+ name = "custom-int-1-to",
+ description =
+ "Filter by upper bound of customInt1. This parameter can't be used together with "
+ + "'custom-int-1-within'.")
@JsonProperty("custom-int-1-to")
private final Integer customInt1To;
/** Exclude values to an upper bound of the field customInt1 of the Task. */
+ @Schema(
+ name = "custom-int-1-to-not",
+ description = "Exclude values to an upper bound of the field customInt1 of the Task.")
@JsonProperty("custom-int-1-to-not")
private final Integer customInt1ToNot;
/** Filter by the value of the field customInt2 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-2",
+ description =
+ "Filter by the value of the field customInt2 of the Task. This is an exact match.")
@JsonProperty("custom-int-2")
private final Integer[] customInt2In;
/** Exclude values of the field customInt2 of the Task. */
+ @Schema(
+ name = "custom-int-2-not",
+ description = "Exclude values of the field customInt2 of the Task.")
@JsonProperty("custom-int-2-not")
private final Integer[] customInt2NotIn;
/** Filter by the range of value of the field customInt2 of the Task. */
+ @Schema(
+ name = "custom-int-2-within",
+ description = "Filter by the range of value of the field customInt2 of the Task.")
@JsonProperty("custom-int-2-within")
private final Integer[] customInt2Within;
/** Exclude range of values of the field customInt2 of the Task. */
+ @Schema(
+ name = "custom-int-2-not-within",
+ description = "Exclude range of values of the field customInt2 of the Task.")
@JsonProperty("custom-int-2-not-within")
private final Integer[] customInt2NotWithin;
/**
@@ -71,9 +369,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-2-within'.
*/
+ @Schema(
+ name = "custom-int-2-from",
+ description =
+ "Filter by lower bound of customInt2. This parameter can't be used together with "
+ + "'custom-int-2-within'.")
@JsonProperty("custom-int-2-from")
private final Integer customInt2From;
/** Exclude values from a lower bound of the field customInt2 of the Task. */
+ @Schema(
+ name = "custom-int-2-from-not",
+ description = "Exclude values from a lower bound of the field customInt2 of the Task.")
@JsonProperty("custom-int-2-from-not")
private final Integer customInt2FromNot;
/**
@@ -81,22 +387,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-2-within'.
*/
+ @Schema(
+ name = "custom-int-2-to",
+ description =
+ "Filter by upper bound of customInt2. This parameter can't be used together with "
+ + "'custom-int-2-within'.")
@JsonProperty("custom-int-2-to")
private final Integer customInt2To;
/** Exclude values to an upper bound of the field customInt2 of the Task. */
+ @Schema(
+ name = "custom-int-2-to-not",
+ description = "Exclude values to an upper bound of the field customInt2 of the Task.")
@JsonProperty("custom-int-2-to-not")
private final Integer customInt2ToNot;
/** Filter by the value of the field customInt3 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-3",
+ description =
+ "Filter by the value of the field customInt3 of the Task. This is an exact match.")
@JsonProperty("custom-int-3")
private final Integer[] customInt3In;
/** Exclude values of the field customInt3 of the Task. */
+ @Schema(
+ name = "custom-int-3-not",
+ description = "Exclude values of the field customInt3 of the Task.")
@JsonProperty("custom-int-3-not")
private final Integer[] customInt3NotIn;
/** Filter by the range of value of the field customInt3 of the Task. */
+ @Schema(
+ name = "custom-int-3-within",
+ description = "Filter by the range of value of the field customInt3 of the Task.")
@JsonProperty("custom-int-3-within")
private final Integer[] customInt3Within;
/** Exclude range of values of the field customInt3 of the Task. */
+ @Schema(
+ name = "custom-int-3-not-within",
+ description = "Exclude range of values of the field customInt3 of the Task.")
@JsonProperty("custom-int-3-not-within")
private final Integer[] customInt3NotWithin;
/**
@@ -104,9 +431,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-3-within'.
*/
+ @Schema(
+ name = "custom-int-3-from",
+ description =
+ "Filter by lower bound of customInt3. This parameter can't be used together with "
+ + "'custom-int-3-within'.")
@JsonProperty("custom-int-3-from")
private final Integer customInt3From;
/** Exclude values from a lower bound of the field customInt3 of the Task. */
+ @Schema(
+ name = "custom-int-3-from-not",
+ description = "Exclude values from a lower bound of the field customInt3 of the Task.")
@JsonProperty("custom-int-3-from-not")
private final Integer customInt3FromNot;
/**
@@ -114,22 +449,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-3-within'.
*/
+ @Schema(
+ name = "custom-int-3-to",
+ description =
+ "Filter by upper bound of customInt3. This parameter can't be used together with "
+ + "'custom-int-3-within'.")
@JsonProperty("custom-int-3-to")
private final Integer customInt3To;
/** Exclude values to an upper bound of the field customInt3 of the Task. */
+ @Schema(
+ name = "custom-int-3-to-not",
+ description = "Exclude values to an upper bound of the field customInt3 of the Task.")
@JsonProperty("custom-int-3-to-not")
private final Integer customInt3ToNot;
/** Filter by the value of the field customInt4 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-4",
+ description =
+ "Filter by the value of the field customInt4 of the Task. This is an exact match.")
@JsonProperty("custom-int-4")
private final Integer[] customInt4In;
/** Exclude values of the field customInt4 of the Task. */
+ @Schema(
+ name = "custom-int-4-not",
+ description = "Exclude values of the field customInt4 of the Task.")
@JsonProperty("custom-int-4-not")
private final Integer[] customInt4NotIn;
/** Filter by the range of value of the field customInt4 of the Task. */
+ @Schema(
+ name = "custom-int-4-within",
+ description = "Filter by the range of value of the field customInt4 of the Task.")
@JsonProperty("custom-int-4-within")
private final Integer[] customInt4Within;
/** Exclude range of values of the field customInt4 of the Task. */
+ @Schema(
+ name = "custom-int-4-not-within",
+ description = "Exclude range of values of the field customInt4 of the Task.")
@JsonProperty("custom-int-4-not-within")
private final Integer[] customInt4NotWithin;
/**
@@ -137,9 +493,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-4-within'.
*/
+ @Schema(
+ name = "custom-int-4-from",
+ description =
+ "Filter by lower bound of customInt4. This parameter can't be used together with "
+ + "'custom-int-4-within'.")
@JsonProperty("custom-int-4-from")
private final Integer customInt4From;
/** Exclude values from a lower bound of the field customInt4 of the Task. */
+ @Schema(
+ name = "custom-int-4-from-not",
+ description = "Exclude values from a lower bound of the field customInt4 of the Task.")
@JsonProperty("custom-int-4-from-not")
private final Integer customInt4FromNot;
/**
@@ -147,22 +511,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-4-within'.
*/
+ @Schema(
+ name = "custom-int-4-to",
+ description =
+ "Filter by upper bound of customInt4. This parameter can't be used together with "
+ + "'custom-int-4-within'.")
@JsonProperty("custom-int-4-to")
private final Integer customInt4To;
/** Exclude values to an upper bound of the field customInt4 of the Task. */
+ @Schema(
+ name = "custom-int-4-to-not",
+ description = "Exclude values to an upper bound of the field customInt4 of the Task.")
@JsonProperty("custom-int-4-to-not")
private final Integer customInt4ToNot;
/** Filter by the value of the field customInt5 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-5",
+ description =
+ "Filter by the value of the field customInt5 of the Task. This is an exact match.")
@JsonProperty("custom-int-5")
private final Integer[] customInt5In;
/** Exclude values of the field customInt5 of the Task. */
+ @Schema(
+ name = "custom-int-5-not",
+ description = "Exclude values of the field customInt5 of the Task.")
@JsonProperty("custom-int-5-not")
private final Integer[] customInt5NotIn;
/** Filter by the range of value of the field customInt5 of the Task. */
+ @Schema(
+ name = "custom-int-5-within",
+ description = "Filter by the range of value of the field customInt5 of the Task.")
@JsonProperty("custom-int-5-within")
private final Integer[] customInt5Within;
/** Exclude range of values of the field customInt5 of the Task. */
+ @Schema(
+ name = "custom-int-5-not-within",
+ description = "Exclude range of values of the field customInt5 of the Task.")
@JsonProperty("custom-int-5-not-within")
private final Integer[] customInt5NotWithin;
/**
@@ -170,9 +555,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-5-within'.
*/
+ @Schema(
+ name = "custom-int-5-from",
+ description =
+ "Filter by lower bound of customInt5. This parameter can't be used together with "
+ + "'custom-int-5-within'.")
@JsonProperty("custom-int-5-from")
private final Integer customInt5From;
/** Exclude values from a lower bound of the field customInt5 of the Task. */
+ @Schema(
+ name = "custom-int-5-from-not",
+ description = "Exclude values from a lower bound of the field customInt5 of the Task.")
@JsonProperty("custom-int-5-from-not")
private final Integer customInt5FromNot;
/**
@@ -180,22 +573,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-5-within'.
*/
+ @Schema(
+ name = "custom-int-5-to",
+ description =
+ "Filter by upper bound of customInt5. This parameter can't be used together with "
+ + "'custom-int-5-within'.")
@JsonProperty("custom-int-5-to")
private final Integer customInt5To;
/** Exclude values to an upper bound of the field customInt5 of the Task. */
+ @Schema(
+ name = "custom-int-5-to-not",
+ description = "Exclude values to an upper bound of the field customInt5 of the Task.")
@JsonProperty("custom-int-5-to-not")
private final Integer customInt5ToNot;
/** Filter by the value of the field customInt6 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-6",
+ description =
+ "Filter by the value of the field customInt6 of the Task. This is an exact match.")
@JsonProperty("custom-int-6")
private final Integer[] customInt6In;
/** Exclude values of the field customInt6 of the Task. */
+ @Schema(
+ name = "custom-int-6-not",
+ description = "Exclude values of the field customInt6 of the Task.")
@JsonProperty("custom-int-6-not")
private final Integer[] customInt6NotIn;
/** Filter by the range of value of the field customInt6 of the Task. */
+ @Schema(
+ name = "custom-int-6-within",
+ description = "Filter by the range of value of the field customInt6 of the Task.")
@JsonProperty("custom-int-6-within")
private final Integer[] customInt6Within;
/** Exclude range of values of the field customInt6 of the Task. */
+ @Schema(
+ name = "custom-int-6-not-within",
+ description = "Exclude range of values of the field customInt6 of the Task.")
@JsonProperty("custom-int-6-not-within")
private final Integer[] customInt6NotWithin;
/**
@@ -203,9 +617,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-6-within'.
*/
+ @Schema(
+ name = "custom-int-6-from",
+ description =
+ "Filter by lower bound of customInt6. This parameter can't be used together with "
+ + "'custom-int-6-within'.")
@JsonProperty("custom-int-6-from")
private final Integer customInt6From;
/** Exclude values from a lower bound of the field customInt6 of the Task. */
+ @Schema(
+ name = "custom-int-6-from-not",
+ description = "Exclude values from a lower bound of the field customInt6 of the Task.")
@JsonProperty("custom-int-6-from-not")
private final Integer customInt6FromNot;
/**
@@ -213,22 +635,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-6-within'.
*/
+ @Schema(
+ name = "custom-int-6-to",
+ description =
+ "Filter by upper bound of customInt6. This parameter can't be used together with "
+ + "'custom-int-6-within'.")
@JsonProperty("custom-int-6-to")
private final Integer customInt6To;
/** Exclude values to an upper bound of the field customInt6 of the Task. */
+ @Schema(
+ name = "custom-int-6-to-not",
+ description = "Exclude values to an upper bound of the field customInt6 of the Task.")
@JsonProperty("custom-int-6-to-not")
private final Integer customInt6ToNot;
/** Filter by the value of the field customInt7 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-7",
+ description =
+ "Filter by the value of the field customInt7 of the Task. This is an exact match.")
@JsonProperty("custom-int-7")
private final Integer[] customInt7In;
/** Exclude values of the field customInt7 of the Task. */
+ @Schema(
+ name = "custom-int-7-not",
+ description = "Exclude values of the field customInt7 of the Task.")
@JsonProperty("custom-int-7-not")
private final Integer[] customInt7NotIn;
/** Filter by the range of value of the field customInt7 of the Task. */
+ @Schema(
+ name = "custom-int-7-within",
+ description = "Filter by the range of value of the field customInt7 of the Task.")
@JsonProperty("custom-int-7-within")
private final Integer[] customInt7Within;
/** Exclude range of values of the field customInt7 of the Task. */
+ @Schema(
+ name = "custom-int-7-not-within",
+ description = "Exclude range of values of the field customInt7 of the Task.")
@JsonProperty("custom-int-7-not-within")
private final Integer[] customInt7NotWithin;
/**
@@ -236,9 +679,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-7-within'.
*/
+ @Schema(
+ name = "custom-int-7-from",
+ description =
+ "Filter by lower bound of customInt7. This parameter can't be used together with "
+ + "'custom-int-7-within'.")
@JsonProperty("custom-int-7-from")
private final Integer customInt7From;
/** Exclude values from a lower bound of the field customInt7 of the Task. */
+ @Schema(
+ name = "custom-int-7-from-not",
+ description = "Exclude values from a lower bound of the field customInt7 of the Task.")
@JsonProperty("custom-int-7-from-not")
private final Integer customInt7FromNot;
/**
@@ -246,22 +697,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-7-within'.
*/
+ @Schema(
+ name = "custom-int-7-to",
+ description =
+ "Filter by upper bound of customInt7. This parameter can't be used together with "
+ + "'custom-int-7-within'.")
@JsonProperty("custom-int-7-to")
private final Integer customInt7To;
/** Exclude values to an upper bound of the field customInt7 of the Task. */
+ @Schema(
+ name = "custom-int-7-to-not",
+ description = "Exclude values to an upper bound of the field customInt7 of the Task.")
@JsonProperty("custom-int-7-to-not")
private final Integer customInt7ToNot;
/** Filter by the value of the field customInt8 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-8",
+ description =
+ "Filter by the value of the field customInt8 of the Task. This is an exact match.")
@JsonProperty("custom-int-8")
private final Integer[] customInt8In;
/** Exclude values of the field customInt8 of the Task. */
+ @Schema(
+ name = "custom-int-8-not",
+ description = "Exclude values of the field customInt8 of the Task.")
@JsonProperty("custom-int-8-not")
private final Integer[] customInt8NotIn;
/** Filter by the range of value of the field customInt8 of the Task. */
+ @Schema(
+ name = "custom-int-8-within",
+ description = "Filter by the range of value of the field customInt8 of the Task.")
@JsonProperty("custom-int-8-within")
private final Integer[] customInt8Within;
/** Exclude range of values of the field customInt8 of the Task. */
+ @Schema(
+ name = "custom-int-8-not-within",
+ description = "Exclude range of values of the field customInt8 of the Task.")
@JsonProperty("custom-int-8-not-within")
private final Integer[] customInt8NotWithin;
/**
@@ -269,9 +741,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-8-within'.
*/
+ @Schema(
+ name = "custom-int-8-from",
+ description =
+ "Filter by lower bound of customInt8. This parameter can't be used together with "
+ + "'custom-int-8-within'.")
@JsonProperty("custom-int-8-from")
private final Integer customInt8From;
/** Exclude values from a lower bound of the field customInt8 of the Task. */
+ @Schema(
+ name = "custom-int-8-from-not",
+ description = "Exclude values from a lower bound of the field customInt8 of the Task.")
@JsonProperty("custom-int-8-from-not")
private final Integer customInt8FromNot;
/**
@@ -279,9 +759,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameterThis parameter can't be used together with 'custom-int-8-within'.
*/
+ @Schema(
+ name = "custom-int-8-to",
+ description =
+ "Filter by upper bound of customInt8. This parameter can't be used together with "
+ + "'custom-int-8-within'.")
@JsonProperty("custom-int-8-to")
private final Integer customInt8To;
/** Exclude values to an upper bound of the field customInt8 of the Task. */
+ @Schema(
+ name = "custom-int-8-to-not",
+ description = "Exclude values to an upper bound of the field customInt8 of the Task.")
@JsonProperty("custom-int-8-to-not")
private final Integer customInt8ToNot;
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 c1af19acbe..7124cc5d2d 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
@@ -1,6 +1,7 @@
package pro.taskana.task.rest;
import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
import java.beans.ConstructorProperties;
import java.time.Instant;
import java.util.ArrayList;
@@ -20,21 +21,652 @@
public class TaskQueryFilterParameter implements QueryParameter {
+ public String[] getTaskIdIn() {
+ return taskIdIn;
+ }
+
+ public String[] getExternalIdIn() {
+ return externalIdIn;
+ }
+
+ public String[] getExternalIdNotIn() {
+ return externalIdNotIn;
+ }
+
+ public Instant[] getReceivedWithin() {
+ return receivedWithin;
+ }
+
+ public Instant getReceivedFrom() {
+ return receivedFrom;
+ }
+
+ public Instant getReceivedUntil() {
+ return receivedUntil;
+ }
+
+ public Instant[] getReceivedNotIn() {
+ return receivedNotIn;
+ }
+
+ public Instant getReceivedFromNot() {
+ return receivedFromNot;
+ }
+
+ public Instant getReceivedUntilNot() {
+ return receivedUntilNot;
+ }
+
+ public Instant[] getCreatedWithin() {
+ return createdWithin;
+ }
+
+ public Instant getCreatedFrom() {
+ return createdFrom;
+ }
+
+ public Instant getCreatedUntil() {
+ return createdUntil;
+ }
+
+ public Instant[] getCreatedNotWithin() {
+ return createdNotWithin;
+ }
+
+ public Instant getCreatedFromNot() {
+ return createdFromNot;
+ }
+
+ public Instant getCreatedUntilNot() {
+ return createdUntilNot;
+ }
+
+ public Instant[] getClaimedWithin() {
+ return claimedWithin;
+ }
+
+ public Instant[] getClaimedNotWithin() {
+ return claimedNotWithin;
+ }
+
+ public Instant[] getModifiedWithin() {
+ return modifiedWithin;
+ }
+
+ public Instant[] getModifiedNotWithin() {
+ return modifiedNotWithin;
+ }
+
+ public Instant[] getPlannedWithin() {
+ return plannedWithin;
+ }
+
+ public Instant getPlannedFrom() {
+ return plannedFrom;
+ }
+
+ public Instant getPlannedUntil() {
+ return plannedUntil;
+ }
+
+ public Instant[] getPlannedNotWithin() {
+ return plannedNotWithin;
+ }
+
+ public Instant getPlannedFromNot() {
+ return plannedFromNot;
+ }
+
+ public Instant getPlannedUntilNot() {
+ return plannedUntilNot;
+ }
+
+ public Instant[] getDueWithin() {
+ return dueWithin;
+ }
+
+ public Instant getDueFrom() {
+ return dueFrom;
+ }
+
+ public Instant getDueUntil() {
+ return dueUntil;
+ }
+
+ public Instant[] getDueNotWithin() {
+ return dueNotWithin;
+ }
+
+ public Instant getDueFromNot() {
+ return dueFromNot;
+ }
+
+ public Instant getDueUntilNot() {
+ return dueUntilNot;
+ }
+
+ public Instant[] getCompletedWithin() {
+ return completedWithin;
+ }
+
+ public Instant getCompletedFrom() {
+ return completedFrom;
+ }
+
+ public Instant getCompletedUntil() {
+ return completedUntil;
+ }
+
+ public Instant[] getCompletedNotWithin() {
+ return completedNotWithin;
+ }
+
+ public Instant getCompletedFromNot() {
+ return completedFromNot;
+ }
+
+ public Instant getCompletedUntilNot() {
+ return completedUntilNot;
+ }
+
+ public String[] getNameIn() {
+ return nameIn;
+ }
+
+ public String[] getNameNotIn() {
+ return nameNotIn;
+ }
+
+ public String[] getNameLike() {
+ return nameLike;
+ }
+
+ public String[] getNameNotLike() {
+ return nameNotLike;
+ }
+
+ public String[] getCreatorIn() {
+ return creatorIn;
+ }
+
+ public String[] getCreatorNotIn() {
+ return creatorNotIn;
+ }
+
+ public String[] getCreatorLike() {
+ return creatorLike;
+ }
+
+ public String[] getCreatorNotLike() {
+ return creatorNotLike;
+ }
+
+ public String[] getNoteLike() {
+ return noteLike;
+ }
+
+ public String[] getNoteNotLike() {
+ return noteNotLike;
+ }
+
+ public String[] getDescriptionLike() {
+ return descriptionLike;
+ }
+
+ public String[] getDescriptionNotLike() {
+ return descriptionNotLike;
+ }
+
+ public int[] getPriorityIn() {
+ return priorityIn;
+ }
+
+ public int[] getPriorityNotIn() {
+ return priorityNotIn;
+ }
+
+ public Integer[] getPriorityWithin() {
+ return priorityWithin;
+ }
+
+ public Integer getPriorityFrom() {
+ return priorityFrom;
+ }
+
+ public Integer getPriorityUntil() {
+ return priorityUntil;
+ }
+
+ public Integer[] getPriorityNotWithin() {
+ return priorityNotWithin;
+ }
+
+ public Integer getPriorityNotFrom() {
+ return priorityNotFrom;
+ }
+
+ public Integer getPriorityNotUntil() {
+ return priorityNotUntil;
+ }
+
+ public TaskState[] getStateIn() {
+ return stateIn;
+ }
+
+ public TaskState[] getStateNotIn() {
+ return stateNotIn;
+ }
+
+ public String[] getClassificationIdIn() {
+ return classificationIdIn;
+ }
+
+ public String[] getClassificationIdNotIn() {
+ return classificationIdNotIn;
+ }
+
+ public String[] getClassificationKeyIn() {
+ return classificationKeyIn;
+ }
+
+ public String[] getClassificationKeyNotIn() {
+ return classificationKeyNotIn;
+ }
+
+ public String[] getClassificationKeyLike() {
+ return classificationKeyLike;
+ }
+
+ public String[] getClassificationKeyNotLike() {
+ return classificationKeyNotLike;
+ }
+
+ public String[] getClassificationParentKeyIn() {
+ return classificationParentKeyIn;
+ }
+
+ public String[] getClassificationParentKeyNotIn() {
+ return classificationParentKeyNotIn;
+ }
+
+ public String[] getClassificationParentKeyLike() {
+ return classificationParentKeyLike;
+ }
+
+ public String[] getClassificationParentKeyNotLike() {
+ return classificationParentKeyNotLike;
+ }
+
+ public String[] getClassificationCategoryIn() {
+ return classificationCategoryIn;
+ }
+
+ public String[] getClassificationCategoryNotIn() {
+ return classificationCategoryNotIn;
+ }
+
+ public String[] getClassificationCategoryLike() {
+ return classificationCategoryLike;
+ }
+
+ public String[] getClassificationCategoryNotLike() {
+ return classificationCategoryNotLike;
+ }
+
+ public String[] getClassificationNameIn() {
+ return classificationNameIn;
+ }
+
+ public String[] getClassificationNameNotIn() {
+ return classificationNameNotIn;
+ }
+
+ public String[] getClassificationNameLike() {
+ return classificationNameLike;
+ }
+
+ public String[] getClassificationNameNotLike() {
+ return classificationNameNotLike;
+ }
+
+ public String[] getWorkbasketIdIn() {
+ return workbasketIdIn;
+ }
+
+ public String[] getWorkbasketIdNotIn() {
+ return workbasketIdNotIn;
+ }
+
+ public String[] getWorkbasketKeyIn() {
+ return workbasketKeyIn;
+ }
+
+ public String[] getWorkbasketKeyNotIn() {
+ return workbasketKeyNotIn;
+ }
+
+ public String getDomain() {
+ return domain;
+ }
+
+ public String[] getBusinessProcessIdIn() {
+ return businessProcessIdIn;
+ }
+
+ public String[] getBusinessProcessIdNot() {
+ return businessProcessIdNot;
+ }
+
+ public String[] getBusinessProcessIdLike() {
+ return businessProcessIdLike;
+ }
+
+ public String[] getBusinessProcessIdNotLike() {
+ return businessProcessIdNotLike;
+ }
+
+ public String[] getParentBusinessProcessIdIn() {
+ return parentBusinessProcessIdIn;
+ }
+
+ public String[] getParentBusinessProcessIdNotIn() {
+ return parentBusinessProcessIdNotIn;
+ }
+
+ public String[] getParentBusinessProcessIdLike() {
+ return parentBusinessProcessIdLike;
+ }
+
+ public String[] getParentBusinessProcessIdNotLike() {
+ return parentBusinessProcessIdNotLike;
+ }
+
+ public String[] getOwnerIn() {
+ return ownerIn;
+ }
+
+ public String[] getOwnerNotIn() {
+ return ownerNotIn;
+ }
+
+ public String[] getOwnerLike() {
+ return ownerLike;
+ }
+
+ public String[] getOwnerNotLike() {
+ return ownerNotLike;
+ }
+
+ public String getOwnerNull() {
+ return ownerNull;
+ }
+
+ public ObjectReference[] getPrimaryObjectReferenceIn() {
+ return primaryObjectReferenceIn;
+ }
+
+ public String[] getPorCompanyIn() {
+ return porCompanyIn;
+ }
+
+ public String[] getPorCompanyNotIn() {
+ return porCompanyNotIn;
+ }
+
+ public String[] getPorCompanyLike() {
+ return porCompanyLike;
+ }
+
+ public String[] getPorCompanyNotLike() {
+ return porCompanyNotLike;
+ }
+
+ public String[] getPorSystemIn() {
+ return porSystemIn;
+ }
+
+ public String[] getPorSystemNotIn() {
+ return porSystemNotIn;
+ }
+
+ public String[] getPorSystemLike() {
+ return porSystemLike;
+ }
+
+ public String[] getPorSystemNotLike() {
+ return porSystemNotLike;
+ }
+
+ public String[] getPorInstanceIn() {
+ return porInstanceIn;
+ }
+
+ public String[] getPorInstanceNotIn() {
+ return porInstanceNotIn;
+ }
+
+ public String[] getPorInstanceLike() {
+ return porInstanceLike;
+ }
+
+ public String[] getPorInstanceNotLike() {
+ return porInstanceNotLike;
+ }
+
+ public String[] getPorTypeIn() {
+ return porTypeIn;
+ }
+
+ public String[] getPorTypeNotIn() {
+ return porTypeNotIn;
+ }
+
+ public String[] getPorTypeLike() {
+ return porTypeLike;
+ }
+
+ public String[] getPorTypeNotLike() {
+ return porTypeNotLike;
+ }
+
+ public String[] getPorValueIn() {
+ return porValueIn;
+ }
+
+ public String[] getPorValueNotIn() {
+ return porValueNotIn;
+ }
+
+ public String[] getPorValueLike() {
+ return porValueLike;
+ }
+
+ public String[] getPorValueNotLike() {
+ return porValueNotLike;
+ }
+
+ public ObjectReference[] getSecondaryObjectReferenceIn() {
+ return secondaryObjectReferenceIn;
+ }
+
+ public String[] getSorCompanyIn() {
+ return sorCompanyIn;
+ }
+
+ public String[] getSorCompanyLike() {
+ return sorCompanyLike;
+ }
+
+ public String[] getSorSystemIn() {
+ return sorSystemIn;
+ }
+
+ public String[] getSorSystemLike() {
+ return sorSystemLike;
+ }
+
+ public String[] getSorInstanceIn() {
+ return sorInstanceIn;
+ }
+
+ public String[] getSorInstanceLike() {
+ return sorInstanceLike;
+ }
+
+ public String[] getSorTypeIn() {
+ return sorTypeIn;
+ }
+
+ public String[] getSorTypeLike() {
+ return sorTypeLike;
+ }
+
+ public String[] getSorValueIn() {
+ return sorValueIn;
+ }
+
+ public String[] getSorValueLike() {
+ return sorValueLike;
+ }
+
+ public Boolean getRead() {
+ return isRead;
+ }
+
+ public Boolean getTransferred() {
+ return isTransferred;
+ }
+
+ public String[] getAttachmentClassificationIdIn() {
+ return attachmentClassificationIdIn;
+ }
+
+ public String[] getAttachmentClassificationIdNotIn() {
+ return attachmentClassificationIdNotIn;
+ }
+
+ public String[] getAttachmentClassificationKeyIn() {
+ return attachmentClassificationKeyIn;
+ }
+
+ public String[] getAttachmentClassificationKeyNotIn() {
+ return attachmentClassificationKeyNotIn;
+ }
+
+ public String[] getAttachmentClassificationKeyLike() {
+ return attachmentClassificationKeyLike;
+ }
+
+ public String[] getAttachmentClassificationKeyNotLike() {
+ return attachmentClassificationKeyNotLike;
+ }
+
+ public String[] getAttachmentClassificationNameIn() {
+ return attachmentClassificationNameIn;
+ }
+
+ public String[] getAttachmentClassificationNameNotIn() {
+ return attachmentClassificationNameNotIn;
+ }
+
+ public String[] getAttachmentClassificationNameLike() {
+ return attachmentClassificationNameLike;
+ }
+
+ public String[] getAttachmentClassificationNameNotLike() {
+ return attachmentClassificationNameNotLike;
+ }
+
+ public String[] getAttachmentChannelIn() {
+ return attachmentChannelIn;
+ }
+
+ public String[] getAttachmentChannelNotIn() {
+ return attachmentChannelNotIn;
+ }
+
+ public String[] getAttachmentChannelLike() {
+ return attachmentChannelLike;
+ }
+
+ public String[] getAttachmentChannelNotLike() {
+ return attachmentChannelNotLike;
+ }
+
+ public String[] getAttachmentReferenceIn() {
+ return attachmentReferenceIn;
+ }
+
+ public String[] getAttachmentReferenceNotIn() {
+ return attachmentReferenceNotIn;
+ }
+
+ public String[] getAttachmentReferenceLike() {
+ return attachmentReferenceLike;
+ }
+
+ public String[] getAttachmentReferenceNotLike() {
+ return attachmentReferenceNotLike;
+ }
+
+ public Instant[] getAttachmentReceivedWithin() {
+ return attachmentReceivedWithin;
+ }
+
+ public Instant[] getAttachmentReceivedNotWithin() {
+ return attachmentReceivedNotWithin;
+ }
+
+ public Boolean getWithoutAttachment() {
+ return withoutAttachment;
+ }
+
+ public CallbackState[] getCallbackStateIn() {
+ return callbackStateIn;
+ }
+
+ public CallbackState[] getCallbackStateNotIn() {
+ return callbackStateNotIn;
+ }
+
+ public WildcardSearchField[] getWildcardSearchFieldIn() {
+ return wildcardSearchFieldIn;
+ }
+
+ public String getWildcardSearchValue() {
+ return wildcardSearchValue;
+ }
+
+ public String[] getTaskIdNotIn() {
+ return taskIdNotIn;
+ }
+
// region id
/** Filter by task id. This is an exact match. */
+ @Schema(name = "task-id", description = "Filter by task id. This is an exact match.")
@JsonProperty("task-id")
private final String[] taskIdIn;
/** Filter by what the task id shouldn't be. This is an exact match. */
+ @Schema(
+ name = "task-id-not",
+ description = "Filter by what the task id shouldn't be. This is an exact match.")
@JsonProperty("task-id-not")
private final String[] taskIdNotIn;
// endregion
// region externalId
/** Filter by the external id of the Task. This is an exact match. */
+ @Schema(
+ name = "external-id",
+ description = "Filter by the external id of the Task. This is an exact match.")
@JsonProperty("external-id")
private final String[] externalIdIn;
/** Filter by what the external id of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "external-id-not",
+ description =
+ "Filter by what the external id of the Task shouldn't be. This is an exact match.")
@JsonProperty("external-id-not")
private final String[] externalIdNotIn;
// endregion
@@ -47,6 +679,12 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'received-from' or 'received-until'.
*/
+ @Schema(
+ name = "received",
+ description =
+ "Filter by a time interval within which the Task was received. To create an open "
+ + "interval you can just leave it blank.
The format is ISO-8601.
This "
+ + "parameter can't be used together with 'received-from' or 'received-until'.")
@JsonProperty("received")
private final Instant[] receivedWithin;
@@ -57,6 +695,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'received'.
*/
+ @Schema(
+ name = "receivedFrom",
+ description =
+ "Filter since a given received timestamp.
The format is ISO-8601."
+ + "
This parameter can't be used together with 'received'.")
@JsonProperty("received-from")
private final Instant receivedFrom;
@@ -67,6 +710,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'received'.
*/
+ @Schema(
+ name = "received-until",
+ description =
+ "Filter until a given received timestamp.
The format is ISO-8601."
+ + "
This parameter can't be used together with 'received'.")
@JsonProperty("received-until")
private final Instant receivedUntil;
@@ -79,6 +727,13 @@ public class TaskQueryFilterParameter implements QueryParameter
* This parameter can't be used together with 'received-not-in-from' or
* 'received-not-in-until'.
*/
+ @Schema(
+ name = "received-not",
+ description =
+ "Filter by a time interval within which the Task wasn't received. To "
+ + "create an open interval you can just leave it blank.
The format is ISO-8601."
+ + "
This parameter can't be used together with 'received-not-in-from' or "
+ + "'received-not-in-until'.")
@JsonProperty("received-not")
private final Instant[] receivedNotIn;
@@ -89,6 +744,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'received-not-in'.
*/
+ @Schema(
+ name = "received-from-not",
+ description =
+ "Filter since a given timestamp where it wasn't received.
The format is "
+ + "ISO-8601.
This parameter can't be used together with 'received-not-in'.")
@JsonProperty("received-from-not")
private final Instant receivedFromNot;
@@ -99,6 +759,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'received-not-in'.
*/
+ @Schema(
+ name = "received-until-not",
+ description =
+ "Filter until a given timestamp where it wasn't received.
The format is "
+ + "ISO-8601.
This parameter can't be used together with 'received-not-in'.")
@JsonProperty("received-until-not")
private final Instant receivedUntilNot;
// endregion
@@ -111,6 +776,12 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'created-from' or 'created-until'.
*/
+ @Schema(
+ name = "created",
+ description =
+ "Filter by a time interval within which the Task was created. To create an open "
+ + "interval you can just leave it blank.
The format is ISO-8601.
This "
+ + "parameter can't be used together with 'created-from' or 'created-until'.")
@JsonProperty("created")
private final Instant[] createdWithin;
@@ -121,6 +792,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'created'.
*/
+ @Schema(
+ name = "created-from",
+ description =
+ "Filter since a given created timestamp.
The format is ISO-8601.
This parameter "
+ + "can't be used together with 'created'.")
@JsonProperty("created-from")
private final Instant createdFrom;
@@ -131,6 +807,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'created'.
*/
+ @Schema(
+ name = "created-until",
+ description =
+ "Filter until a given created timestamp.
The format is ISO-8601.
This parameter "
+ + "can't be used together with 'created'.")
@JsonProperty("created-until")
private final Instant createdUntil;
@@ -142,6 +823,13 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'created-not-in-from' or 'created-not-in-until'.
*/
+ @Schema(
+ name = "created-not",
+ description =
+ "Filter by a time interval within which the Task wasn't created. To create an open "
+ + "interval you can just leave it blank.
The format is ISO-8601.
This "
+ + "parameter can't be used together with 'created-not-in-from' or "
+ + "'created-not-in-until'.")
@JsonProperty("created-not")
private final Instant[] createdNotWithin;
@@ -152,6 +840,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'created-not-in'.
*/
+ @Schema(
+ name = "created-from-not",
+ description =
+ "Filter not since a given timestamp where it wasn't created.
The format is ISO-8601."
+ + "
This parameter can't be used together with 'created-not-in'.")
@JsonProperty("created-from-not")
private final Instant createdFromNot;
@@ -162,6 +855,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'created-not-in'.
*/
+ @Schema(
+ name = "created-until-not",
+ description =
+ "Filter not until a given timestamp where it wasn't created.
The format is ISO-8601."
+ + "
This parameter can't be used together with 'created-not-in'.")
@JsonProperty("created-until-not")
private final Instant createdUntilNot;
// endregion
@@ -172,6 +870,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* The format is ISO-8601.
*/
+ @Schema(
+ name = "claimed",
+ description =
+ "Filter by a time interval within which the Task was claimed. To create an open "
+ + "interval you can just leave it blank.
The format is ISO-8601.")
@JsonProperty("claimed")
private final Instant[] claimedWithin;
@@ -181,6 +884,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* The format is ISO-8601.
*/
+ @Schema(
+ name = "claimed-not",
+ description =
+ "Filter by a time interval within which the Task wasn't claimed. To create an open "
+ + "interval you can just leave it blank.
The format is ISO-8601.")
@JsonProperty("claimed-not")
private final Instant[] claimedNotWithin;
// endregion
@@ -191,6 +899,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* The format is ISO-8601.
*/
+ @Schema(
+ name = "modified",
+ description =
+ "Filter by a time interval within which the Task was modified. To create an open "
+ + "interval you can just leave it blank.
The format is ISO-8601.")
@JsonProperty("modified")
private final Instant[] modifiedWithin;
@@ -200,6 +913,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* The format is ISO-8601.
*/
+ @Schema(
+ name = "modified-not",
+ description =
+ "Filter by a time interval within which the Task wasn't modified. To create an open "
+ + "interval you can just leave it blank.
The format is ISO-8601.")
@JsonProperty("modified-not")
private final Instant[] modifiedNotWithin;
// endregion
@@ -212,6 +930,12 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'planned-from' or 'planned-until'.
*/
+ @Schema(
+ name = "planned",
+ description =
+ "Filter by a time interval within which the Task was planned. To create an open "
+ + "interval you can just leave it blank.
The format is ISO-8601.
This "
+ + "parameter can't be used together with 'planned-from' or 'planned-until'.")
@JsonProperty("planned")
private final Instant[] plannedWithin;
@@ -222,6 +946,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'planned'.
*/
+ @Schema(
+ name = "planned-from",
+ description =
+ "Filter since a given planned timestamp.
The format is ISO-8601.
This parameter "
+ + "can't be used together with 'planned'.")
@JsonProperty("planned-from")
private final Instant plannedFrom;
@@ -232,6 +961,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'planned'.
*/
+ @Schema(
+ name = "planned-until",
+ description =
+ "Filter until a given planned timestamp.
The format is ISO-8601.
This parameter "
+ + "can't be used together with 'planned'.")
@JsonProperty("planned-until")
private final Instant plannedUntil;
@@ -243,6 +977,13 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'planned-not-in-from' or 'planned-not-in-until'.
*/
+ @Schema(
+ name = "planned-not",
+ description =
+ "Filter by a time interval within which the Task was planned. To create an open "
+ + "interval you can just leave it blank.
The format is ISO-8601.
This "
+ + "parameter can't be used together with 'planned-not-in-from' or "
+ + "'planned-not-in-until'.")
@JsonProperty("planned-not")
private final Instant[] plannedNotWithin;
@@ -253,6 +994,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'planned-not-in'.
*/
+ @Schema(
+ name = "planned-from-not",
+ description =
+ "Filter since a given timestamp where it wasn't planned.
The format is ISO-8601."
+ + "
This parameter can't be used together with 'planned-not-in'.")
@JsonProperty("planned-from-not")
private final Instant plannedFromNot;
@@ -263,6 +1009,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'planned-not-in'.
*/
+ @Schema(
+ name = "planned-until-not",
+ description =
+ "Filter until a given timestamp where it wasn't planned.
The format is ISO-8601."
+ + "
This parameter can't be used together with 'planned-not-in'.")
@JsonProperty("planned-until-not")
private final Instant plannedUntilNot;
// endregion
@@ -275,7 +1026,13 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'due-from' or 'due-until'.
*/
- @JsonProperty("due")
+ @Schema(
+ name = "due",
+ description =
+ "Filter by a time interval within which the Task was due. To create an open interval "
+ + "you can just leave it blank.
The format is ISO-8601.
This parameter can't be"
+ + " used together with 'due-from' or 'due-until'.")
+ @JsonProperty("ued")
private final Instant[] dueWithin;
/**
@@ -285,6 +1042,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'due'.
*/
+ @Schema(
+ name = "due-from",
+ description =
+ "Filter since a given due timestamp.
The format is ISO-8601.
This parameter can't "
+ + "be used together with 'due'.")
@JsonProperty("due-from")
private final Instant dueFrom;
@@ -295,6 +1057,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'due'.
*/
+ @Schema(
+ name = "due-until",
+ description =
+ "Filter until a given due timestamp.
The format is ISO-8601.
This parameter can't "
+ + "be used together with 'due'.")
@JsonProperty("due-until")
private final Instant dueUntil;
@@ -306,6 +1073,12 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'due-not-in-from' or 'due-not-in-until'.
*/
+ @Schema(
+ name = "due-not",
+ description =
+ "Filter by a time interval within which the Task wasn't due. To create an open interval"
+ + " you can just leave it blank.
The format is ISO-8601.
This parameter can't be"
+ + " used together with 'due-not-in-from' or 'due-not-in-until'.")
@JsonProperty("due-not")
private final Instant[] dueNotWithin;
@@ -316,6 +1089,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'due-not-in'.
*/
+ @Schema(
+ name = "due-from-not",
+ description =
+ "Filter since a given timestamp where it isn't due.
The format is ISO-8601.
This "
+ + "parameter can't be used together with 'due-not-in'.")
@JsonProperty("due-from-not")
private final Instant dueFromNot;
@@ -326,6 +1104,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'due-not-in'.
*/
+ @Schema(
+ name = "due-until-not",
+ description =
+ "Filter until a given timestamp where it isn't due.
The format is ISO-8601.
This "
+ + "parameter can't be used together with 'due-not-in'.")
@JsonProperty("due-until-not")
private final Instant dueUntilNot;
// endregion
@@ -338,6 +1121,12 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'completed-from' or 'completed-until'.
*/
+ @Schema(
+ name = "completed",
+ description =
+ "Filter by a time interval within which the Task was completed. To create an open "
+ + "interval you can just leave it blank.
The format is ISO-8601.
This parameter"
+ + " can't be used together with 'completed-from' or 'completed-until'.")
@JsonProperty("completed")
private final Instant[] completedWithin;
@@ -348,6 +1137,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'completed'.
*/
+ @Schema(
+ name = "completed-from",
+ description =
+ "Filter since a given completed timestamp.
The format is ISO-8601.
This parameter "
+ + "can't be used together with 'completed'.")
@JsonProperty("completed-from")
private final Instant completedFrom;
@@ -358,6 +1152,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'completed'.
*/
+ @Schema(
+ name = "completed-until",
+ description =
+ "Filter until a given completed timestamp.
The format is ISO-8601.
This parameter "
+ + "can't be used together with 'completed'.")
@JsonProperty("completed-until")
private final Instant completedUntil;
@@ -370,6 +1169,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* This parameter can't be used together with 'completed-not-in-from' or
* 'completed-not-in-until'.
*/
+ @Schema(
+ name = "completed-not",
+ description =
+ "Filter by a time interval within which the Task wasn't completed. To create an open "
+ + "interval you can just leave it blank.
The format is ISO-8601.
This parameter "
+ + "can't be used together with 'completed-not-in-from' or 'completed-not-in-until'.")
@JsonProperty("completed-not")
private final Instant[] completedNotWithin;
@@ -380,6 +1185,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'completed-not-in'.
*/
+ @Schema(
+ name = "completed-from-not",
+ description =
+ "Filter since a given timestamp where it wasn't completed.
The format is ISO-8601. "
+ + "
This parameter can't be used together with 'completed-not-in'.")
@JsonProperty("completed-from-not")
private final Instant completedFromNot;
@@ -390,15 +1200,24 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This parameter can't be used together with 'completed-not-in'.
*/
+ @Schema(
+ name = "completed-until-not",
+ description =
+ "Filter until a given timestamp where it wasn't completed.
The format is ISO-8601. "
+ + "
This parameter can't be used together with 'completed-not-in'.")
@JsonProperty("completed-until-not")
private final Instant completedUntilNot;
// endregion
// region name
/** Filter by the name of the Task. This is an exact match. */
+ @Schema(name = "name", description = "Filter by the name of the Task. This is an exact match.")
@JsonProperty("name")
private final String[] nameIn;
/** Filter by what the name of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "name-not",
+ description = "Filter by what the name of the Task shouldn't be. This is an exact match.")
@JsonProperty("name-not")
private final String[] nameNotIn;
@@ -407,6 +1226,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved
* correctly.
*/
+ @Schema(
+ name = "name-like",
+ description =
+ "Filter by the name of the Task. This results in a substring search (% is appended to "
+ + "the front and end of the requested value). Further SQL \"LIKE\" wildcard "
+ + "characters will be resolved correctly.")
@JsonProperty("name-like")
private final String[] nameLike;
@@ -415,15 +1240,25 @@ public class TaskQueryFilterParameter implements QueryParameter
* appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters
* will be resolved correctly.
*/
+ @Schema(
+ name = "name-not-like",
+ description =
+ "Filter by what the name of the Task shouldn't be. This results in a substring search "
+ + "(% is appended to the front and end of the requested value). Further SQL "
+ + "\"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("name-not-like")
private final String[] nameNotLike;
// endregion
// region creator
/** Filter by creator of the Task. This is an exact match. */
+ @Schema(name = "creator", description = "Filter by creator of the Task. This is an exact match.")
@JsonProperty("creator")
private final String[] creatorIn;
/** Filter by what the creator of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "creator-not",
+ description = "Filter by what the creator of the Task shouldn't be. This is an exact match.")
@JsonProperty("creator-not")
private final String[] creatorNotIn;
@@ -432,6 +1267,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved
* correctly.
*/
+ @Schema(
+ name = "creator-like",
+ description =
+ "Filter by the creator of the Task. This results in a substring search (% is appended to"
+ + " the front and end of the requested value). Further SQL \"LIKE\" wildcard "
+ + "characters will be resolved correctly.")
@JsonProperty("creator-like")
private final String[] creatorLike;
@@ -440,6 +1281,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters
* will be resolved correctly.
*/
+ @Schema(
+ name = "creator-not-like",
+ description =
+ "Filter by what the creator of the Task shouldn't be. This results in a substring "
+ + "search (% is appended to the front and end of the requested value). Further SQL "
+ + "\"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("creator-not-like")
private final String[] creatorNotLike;
// endregion
@@ -449,6 +1296,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved
* correctly.
*/
+ @Schema(
+ name = "note-like",
+ description =
+ "Filter by the note of the Task. This results in a substring search (% is appended to"
+ + " the front and end of the requested value). Further SQL \"LIKE\" wildcard "
+ + "characters will be resolved correctly.")
@JsonProperty("note-like")
private final String[] noteLike;
@@ -457,6 +1310,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters
* will be resolved correctly.
*/
+ @Schema(
+ name = "note-not-like",
+ description =
+ "Filter by what the note of the Task shouldn't be. This results in a substring search "
+ + "(% is appended to the front and end of the requested value). Further SQL \"LIKE\""
+ + " wildcard characters will be resolved correctly.")
@JsonProperty("note-not-like")
private final String[] noteNotLike;
// endregion
@@ -466,6 +1325,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved
* correctly.
*/
+ @Schema(
+ name = "description-like",
+ description =
+ "Filter by the description of the Task. This results in a substring search (% is "
+ + "appended to the front and end of the requested value). Further SQL \"LIKE\" "
+ + "wildcard characters will be resolved correctly.")
@JsonProperty("description-like")
private final String[] descriptionLike;
@@ -474,66 +1339,113 @@ public class TaskQueryFilterParameter implements QueryParameter
* is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "description-not-like",
+ description =
+ "Filter by what the description of the Task shouldn't be. This results in a substring "
+ + "search (% is appended to the front and end of the requested value). Further SQL "
+ + "\"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("description-not-like")
private final String[] descriptionNotLike;
// endregion
// region priority
/** Filter by the priority of the Task. This is an exact match. */
+ @Schema(
+ name = "priority",
+ description = "Filter by the priority of the Task. This is an exact match.")
@JsonProperty("priority")
private final int[] priorityIn;
/** Filter by what the priority of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "priority-not",
+ description = "Filter by what the priority of the Task shouldn't be. This is an exact match.")
@JsonProperty("priority-not")
private final int[] priorityNotIn;
/** Filter by the range of values of the priority field of the Task. */
+ @Schema(
+ name = "priority-within",
+ description = "Filter by the range of values of the priority field of the Task.")
@JsonProperty("priority-within")
private final Integer[] priorityWithin;
/** Filter by priority starting from the given value (inclusive). */
+ @Schema(
+ name = "priority-from",
+ description = "Filter by priority starting from the given value (inclusive).")
@JsonProperty("priority-from")
private final Integer priorityFrom;
/** Filter by priority up to the given value (inclusive). */
+ @Schema(
+ name = "priority-until",
+ description = "Filter by priority up to the given value (inclusive).")
@JsonProperty("priority-until")
private final Integer priorityUntil;
/** Filter by exclusing the range of values of the priority field of the Task. */
+ @Schema(
+ name = "priority-not-within",
+ description = "Filter by exclusing the range of values of the priority field of the Task.")
@JsonProperty("priority-not-within")
private final Integer[] priorityNotWithin;
/** Filter by excluding priority starting from the given value (inclusive). */
+ @Schema(
+ name = "priority-not-from",
+ description = "Filter by excluding priority starting from the given value (inclusive).")
@JsonProperty("priority-not-from")
private final Integer priorityNotFrom;
/** Filter by excluding priority up to the given value (inclusive). */
+ @Schema(
+ name = "priority-not-until",
+ description = "Filter by excluding priority up to the given value (inclusive).")
@JsonProperty("priority-not-until")
private final Integer priorityNotUntil;
// endregion
// region state
/** Filter by the Task state. This is an exact match. */
+ @Schema(name = "state", description = "Filter by the Task state. This is an exact match.")
@JsonProperty("state")
private final TaskState[] stateIn;
/** Filter by what the Task state shouldn't be. This is an exact match. */
+ @Schema(
+ name = "state-not",
+ description = "Filter by what the Task state shouldn't be. This is an exact match.")
@JsonProperty("state-not")
private final TaskState[] stateNotIn;
// endregion
// region classificationId
/** Filter by the classification id of the Task. This is an exact match. */
+ @Schema(
+ name = "classification-id",
+ description = "Filter by the classification id of the Task. This is an exact match.")
@JsonProperty("classification-id")
private final String[] classificationIdIn;
/** Filter by what the classification id of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "classification-id-not",
+ description =
+ "Filter by what the classification id of the Task shouldn't be. This is an exact match.")
@JsonProperty("classification-id-not")
private final String[] classificationIdNotIn;
// endregion
// region classificationKey
/** Filter by the classification key of the Task. This is an exact match. */
+ @Schema(
+ name = "classification-key",
+ description = "Filter by the classification key of the Task. This is an exact match.")
@JsonProperty("classification-key")
private final String[] classificationKeyIn;
/** Filter by the classification key of the Task. This is an exact match. */
+ @Schema(
+ name = "classification-key-not",
+ description = "Filter by the classification key of the Task. This is an exact match.")
@JsonProperty("classification-key-not")
private final String[] classificationKeyNotIn;
@@ -542,6 +1454,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be
* resolved correctly.
*/
+ @Schema(
+ name = "classification-key-like",
+ description =
+ "Filter by the classification key of the Task. This results in a substring search (% is"
+ + " appended to the front and end of the requested value). Further SQL \"LIKE\" "
+ + "wildcard characters will be resolved correctly.")
@JsonProperty("classification-key-like")
private final String[] classificationKeyLike;
@@ -550,6 +1468,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "classification-key-not-like",
+ description =
+ "Filter by what the classification key of the Task shouldn't be. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("classification-key-not-like")
private final String[] classificationKeyNotLike;
// endregion
@@ -558,6 +1482,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by the key of the parent Classification of the Classification of the Task. This is an
* exact match.
*/
+ @Schema(
+ name = "classification-parent-key",
+ description =
+ "Filter by the key of the parent Classification of the Classification of the Task. This"
+ + " is an exact match.")
@JsonProperty("classification-parent-key")
private final String[] classificationParentKeyIn;
@@ -565,6 +1494,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by what the key of the parent Classification of the Classification of the Task shouldn't
* be. This is an exact match.
*/
+ @Schema(
+ name = "classification-parent-key-not",
+ description =
+ "Filter by what the key of the parent Classification of the Classification of the Task "
+ + "shouldn't be. This is an exact match.")
@JsonProperty("classification-parent-key-not")
private final String[] classificationParentKeyNotIn;
@@ -573,6 +1507,13 @@ public class TaskQueryFilterParameter implements QueryParameter
* in a substring search (% is appended to the front and end of the requested value). Further SQL
* "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "classification-parent-key-like",
+ description =
+ "Filter by the key of the parent Classification of the Classification of the Task. This"
+ + " results in a substring search (% is appended to the front and end of the "
+ + "requested value). Further SQL \"LIKE\" wildcard characters will be resolved "
+ + "correctly.")
@JsonProperty("classification-parent-key-like")
private final String[] classificationParentKeyLike;
@@ -581,17 +1522,32 @@ public class TaskQueryFilterParameter implements QueryParameter
* be. This results in a substring search (% is appended to the front and end of the requested
* value). Further SQL "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "classification-parent-key-not-like",
+ description =
+ "Filter by what the key of the parent Classification of the Classification of the Task "
+ + "shouldn't be. This results in a substring search (% is appended to the front and "
+ + "end of the requested value). Further SQL \"LIKE\" wildcard characters will be "
+ + "resolved correctly.")
@JsonProperty("classification-parent-key-not-like")
private final String[] classificationParentKeyNotLike;
// endregion
// region classificationCategory
/** Filter by the classification category of the Task. This is an exact match. */
+ @Schema(
+ name = "classification-category",
+ description = "Filter by the classification category of the Task. This is an exact match.")
@JsonProperty("classification-category")
private final String[] classificationCategoryIn;
/**
* Filter by what the classification category of the Task shouldn't be. This is an exact match.
*/
+ @Schema(
+ name = "classification-category-not",
+ description =
+ "Filter by what the classification category of the Task shouldn't be. This is an exact "
+ + "match.")
@JsonProperty("classification-category-not")
private final String[] classificationCategoryNotIn;
@@ -600,6 +1556,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters
* will be resolved correctly.
*/
+ @Schema(
+ name = "classification-category-like",
+ description =
+ "Filter by the classification category of the Task. This results in a substring search "
+ + "(% is appended to the front and end of the requested value). Further SQL \"LIKE\""
+ + " wildcard characters will be resolved correctly.")
@JsonProperty("classification-category-like")
private final String[] classificationCategoryLike;
@@ -608,15 +1570,29 @@ public class TaskQueryFilterParameter implements QueryParameter
* substring search (% is appended to the front and end of the requested value). Further SQL
* "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "classification-category-not-like",
+ description =
+ "Filter by what the classification category of the Task shouldn't be. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("classification-category-not-like")
private final String[] classificationCategoryNotLike;
// endregion
// region classificationName
/** Filter by the classification name of the Task. This is an exact match. */
+ @Schema(
+ name = "classification-name",
+ description = "Filter by the classification name of the Task. This is an exact match.")
@JsonProperty("classification-name")
private final String[] classificationNameIn;
/** Filter by what the classification name of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "classification-name-not",
+ description =
+ "Filter by what the classification name of the Task shouldn't be. This is an exact "
+ + "match.")
@JsonProperty("classification-name-not")
private final String[] classificationNameNotIn;
@@ -625,6 +1601,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters
* will be resolved correctly.
*/
+ @Schema(
+ name = "classification-name-like",
+ description =
+ "Filter by the classification name of the Task. This results in a substring search (% "
+ + "is appended to the front and end of the requested value). Further SQL \"LIKE\" "
+ + "wildcard characters will be resolved correctly.")
@JsonProperty("classification-name-like")
private final String[] classificationNameLike;
@@ -633,15 +1615,28 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "classification-name-not-like",
+ description =
+ "Filter by what the classification name of the Task shouldn't be. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("classification-name-not-like")
private final String[] classificationNameNotLike;
// endregion
// region workbasketId
/** Filter by workbasket id of the Task. This is an exact match. */
+ @Schema(
+ name = "workbasket-id",
+ description = "Filter by workbasket id of the Task. This is an exact match.")
@JsonProperty("workbasket-id")
private final String[] workbasketIdIn;
/** Filter by what the workbasket id of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "workbasket-id-not",
+ description =
+ "Filter by what the workbasket id of the Task shouldn't be. This is an exact match.")
@JsonProperty("workbasket-id-not")
private final String[] workbasketIdNotIn;
// endregion
@@ -650,6 +1645,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by workbasket keys of the Task. This parameter can only be used in combination with
* 'domain'
*/
+ @Schema(
+ name = "workbasket-key",
+ description =
+ "Filter by workbasket keys of the Task. This parameter can only be used in combination "
+ + "with 'domain'")
@JsonProperty("workbasket-key")
private final String[] workbasketKeyIn;
@@ -657,19 +1657,33 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by what the workbasket keys of the Task aren't. This parameter can only be used in
* combination with 'domain'
*/
+ @Schema(
+ name = "workbasket-key-not",
+ description =
+ "Filter by what the workbasket keys of the Task aren't. This parameter can only be used "
+ + "in combination with 'domain'")
@JsonProperty("workbasket-key-not")
private final String[] workbasketKeyNotIn;
/** Filter by domain of the Task. This is an exact match. */
+ @Schema(name = "domain", description = "Filter by domain of the Task. This is an exact match.")
@JsonProperty("domain")
private final String domain;
// endregion
// region businessProcessId
/** Filter by the business process id of the Task. This is an exact match. */
+ @Schema(
+ name = "business-process-id",
+ description = "Filter by the business process id of the Task. This is an exact match.")
@JsonProperty("business-process-id")
private final String[] businessProcessIdIn;
/** Filter by what the business process id of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "business-process-id-not",
+ description =
+ "Filter by what the business process id of the Task shouldn't be. This is an exact "
+ + "match.")
@JsonProperty("business-process-id-not")
private final String[] businessProcessIdNot;
@@ -678,6 +1692,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters
* will be resolved correctly.
*/
+ @Schema(
+ name = "business-process-id-like",
+ description =
+ "Filter by the business process id of the Task. This results in a substring search (% is"
+ + " appended to the front and end of the requested value). Further SQL \"LIKE\" "
+ + "wildcard characters will be resolved correctly.")
@JsonProperty("business-process-id-like")
private final String[] businessProcessIdLike;
@@ -686,18 +1706,32 @@ public class TaskQueryFilterParameter implements QueryParameter
* (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "business-process-id-not-like",
+ description =
+ "Filter by the business process id of the Task shouldn't be. This results in a substring"
+ + " search (% is appended to the front and end of the requested value). Further SQL "
+ + "\"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("business-process-id-not-like")
private final String[] businessProcessIdNotLike;
// endregion
// region parentBusinessProcessId
/** Filter by the parent business process id of the Task. This is an exact match. */
+ @Schema(
+ name = "parent-business-process-id",
+ description = "Filter by the parent business process id of the Task. This is an exact match.")
@JsonProperty("parent-business-process-id")
private final String[] parentBusinessProcessIdIn;
/**
* Filter by what the parent business process id of the Task shouldn't be. This is an exact match.
*/
+ @Schema(
+ name = "parent-business-process-id-not",
+ description =
+ "Filter by what the parent business process id of the Task shouldn't be. This is an "
+ + "exact match.")
@JsonProperty("parent-business-process-id-not")
private final String[] parentBusinessProcessIdNotIn;
@@ -706,6 +1740,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters
* will be resolved correctly.
*/
+ @Schema(
+ name = "parent-business-process-id-like",
+ description =
+ "Filter by the parent business process id of the Task. This results in a substring "
+ + "search (% is appended to the front and end of the requested value). Further SQL "
+ + "\"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("parent-business-process-id-like")
private final String[] parentBusinessProcessIdLike;
@@ -714,6 +1754,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "parent-business-process-id-not-like",
+ description =
+ "Filter by the parent business process id of the Task shouldn't be. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("parent-business-process-id-not-like")
private final String[] parentBusinessProcessIdNotLike;
@@ -724,6 +1770,9 @@ public class TaskQueryFilterParameter implements QueryParameter
private final String[] ownerIn;
/** Filter by what the owner of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "owner-not",
+ description = "Filter by what the owner of the Task shouldn't be. This is an exact match.")
@JsonProperty("owner-not")
private final String[] ownerNotIn;
@@ -732,6 +1781,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved
* correctly.
*/
+ @Schema(
+ name = "owner-like",
+ description =
+ "Filter by the owner of the Task. This results in a substring search (% is appended to "
+ + "the front and end of the requested value). Further SQL \"LIKE\" wildcard "
+ + "characters will be resolved correctly.")
@JsonProperty("owner-like")
private final String[] ownerLike;
@@ -740,6 +1795,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters
* will be resolved correctly.
*/
+ @Schema(
+ name = "owner-not-like",
+ description =
+ "Filter by what the owner of the Task shouldn't be. This results in a substring search "
+ + "(% is appended to the front and end of the requested value). Further SQL \"LIKE\""
+ + " wildcard characters will be resolved correctly.")
@JsonProperty("owner-not-like")
private final String[] ownerNotLike;
@@ -747,6 +1808,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by tasks that have no owner. The parameter should exactly be "owner-is-null" without
* being followed by "=..."
*/
+ @Schema(
+ name = "owner-is-null",
+ description =
+ "Filter by tasks that have no owner. The parameter should exactly be \"owner-is-null\" "
+ + "without being followed by \"=...\"")
@JsonProperty("owner-is-null")
private final String ownerNull;
// endregion
@@ -757,11 +1823,23 @@ public class TaskQueryFilterParameter implements QueryParameter
* specified according to the description of complex parameters in the overview, e.g.
* por={"value":"exampleValue"}
*/
+ @Schema(
+ name = "por",
+ description =
+ "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. */
+ @Schema(
+ name = "por-company",
+ description =
+ "Filter by the company of the primary object reference of the Task. This is an exact "
+ + "match.")
@JsonProperty("por-company")
private final String[] porCompanyIn;
@@ -769,6 +1847,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by what the company of the primary object reference of the Task shouldn't be. This is an
* exact match.
*/
+ @Schema(
+ name = "por-company-not",
+ description =
+ "Filter by what the company of the primary object reference of the Task shouldn't be. "
+ + "This is an exact match.")
@JsonProperty("por-company-not")
private final String[] porCompanyNotIn;
@@ -777,6 +1860,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "por-company-like",
+ description =
+ "Filter by the company of the primary object reference of the Task. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("por-company-like")
private final String[] porCompanyLike;
@@ -785,11 +1874,23 @@ public class TaskQueryFilterParameter implements QueryParameter
* results in a substring search (% is appended to the front and end of the requested value).
* Further SQL "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "por-company-not-like",
+ description =
+ "Filter by what the company of the primary object reference of the Task shouldn't be. "
+ + "This results in a substring search (% is appended to the front and end of the "
+ + "requested value). Further SQL \"LIKE\" wildcard characters will be resolved "
+ + "correctly.")
@JsonProperty("por-company-not-like")
private final String[] porCompanyNotLike;
// endregion
// region primaryObjectReferenceSystem
/** Filter by the system of the primary object reference of the Task. This is an exact match. */
+ @Schema(
+ name = "por-system",
+ description =
+ "Filter by the system of the primary object reference of the Task. This is an exact "
+ + "match.")
@JsonProperty("por-system")
private final String[] porSystemIn;
@@ -797,6 +1898,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by what the system of the primary object reference of the Task shouldn't be. This is an
* exact match.
*/
+ @Schema(
+ name = "por-system-not",
+ description =
+ "Filter by what the system of the primary object reference of the Task shouldn't be. "
+ + "This is an exact match.")
@JsonProperty("por-system-not")
private final String[] porSystemNotIn;
@@ -805,6 +1911,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "por-system-like",
+ description =
+ "Filter by the system of the primary object reference of the Task. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("por-system-like")
private final String[] porSystemLike;
@@ -813,6 +1925,13 @@ public class TaskQueryFilterParameter implements QueryParameter
* results in a substring search (% is appended to the front and end of the requested value).
* Further SQL "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "por-system-not-like",
+ description =
+ "Filter by what the system of the primary object reference of the Task shouldn't be. "
+ + "This results in a substring search (% is appended to the front and end of the "
+ + "requested value). Further SQL \"LIKE\" wildcard characters will be resolved "
+ + "correctly.")
@JsonProperty("por-system-not-like")
private final String[] porSystemNotLike;
// endregion
@@ -821,6 +1940,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by the system instance of the primary object reference of the Task. This is an exact
* match.
*/
+ @Schema(
+ name = "por-instance",
+ description =
+ "Filter by the system instance of the primary object reference of the Task. This is an "
+ + "exact match.")
@JsonProperty("por-instance")
private final String[] porInstanceIn;
@@ -828,6 +1952,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by what the system instance of the primary object reference of the Task shouldn't be.
* This is an exact match.
*/
+ @Schema(
+ name = "por-instance-not",
+ description =
+ "Filter by what the system instance of the primary object reference of the Task "
+ + "shouldn't be. This is an exact match.")
@JsonProperty("por-instance-not")
private final String[] porInstanceNotIn;
@@ -836,6 +1965,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* substring search (% is appended to the front and end of the requested value). Further SQL
* "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "por-instance-like",
+ description =
+ "Filter by the system instance of the primary object reference of the Task. This results"
+ + " in a substring search (% is appended to the front and end of the requested "
+ + "value). Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("por-instance-like")
private final String[] porInstanceLike;
@@ -844,11 +1979,22 @@ public class TaskQueryFilterParameter implements QueryParameter
* This results in a substring search (% is appended to the front and end of the requested value).
* Further SQL "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "por-instance-not-like",
+ description =
+ "Filter by what the system instance of the primary object reference of the Task "
+ + "shouldn't be. This results in a substring search (% is appended to the front and"
+ + " end of the requested value). Further SQL \"LIKE\" wildcard characters will be "
+ + "resolved correctly.")
@JsonProperty("por-instance-not-like")
private final String[] porInstanceNotLike;
// endregion
// region primaryObjectReferenceSystemType
/** Filter by the type of the primary object reference of the Task. This is an exact match. */
+ @Schema(
+ name = "por-type",
+ description =
+ "Filter by the type of the primary object reference of the Task. This is an exact match.")
@JsonProperty("por-type")
private final String[] porTypeIn;
@@ -856,6 +2002,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by what the type of the primary object reference of the Task shouldn't be. This is an
* exact match.
*/
+ @Schema(
+ name = "por-type-not",
+ description =
+ "Filter by what the type of the primary object reference of the Task shouldn't be. This "
+ + "is an exact match.")
@JsonProperty("por-type-not")
private final String[] porTypeNotIn;
@@ -864,6 +2015,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "por-type-like",
+ description =
+ "Filter by the type of the primary object reference of the Task. This results in a "
+ + "substring search (% is appended to the front and end of the requested value)."
+ + " Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("por-type-like")
private final String[] porTypeLike;
@@ -872,11 +2029,23 @@ public class TaskQueryFilterParameter implements QueryParameter
* in a substring search (% is appended to the front and end of the requested value). Further SQL
* "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "por-type-not-like",
+ description =
+ "Filter by what the type of the primary object reference of the Task shouldn't be. This "
+ + "results in a substring search (% is appended to the front and end of the "
+ + "requested value). Further SQL \"LIKE\" wildcard characters will be resolved "
+ + "correctly.")
@JsonProperty("por-type-not-like")
private final String[] porTypeNotLike;
// endregion
// region primaryObjectReferenceSystemValue
/** Filter by the value of the primary object reference of the Task. This is an exact match. */
+ @Schema(
+ name = "por-value",
+ description =
+ "Filter by the value of the primary object reference of the Task. This is an exact "
+ + "match.")
@JsonProperty("por-value")
private final String[] porValueIn;
@@ -884,6 +2053,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by what the value of the primary object reference of the Task shouldn't be. This is an
* exact match.
*/
+ @Schema(
+ name = "por-value-not",
+ description =
+ "Filter by what the value of the primary object reference of the Task shouldn't be. This"
+ + " is an exact match.")
@JsonProperty("por-value-not")
private final String[] porValueNotIn;
@@ -892,6 +2066,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "por-value-like",
+ description =
+ "Filter by the value of the primary object reference of the Task. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("por-value-like")
private final String[] porValueLike;
@@ -900,6 +2080,13 @@ public class TaskQueryFilterParameter implements QueryParameter
* in a substring search (% is appended to the front and end of the requested value). Further SQL
* "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "por-value-not-like",
+ description =
+ "Filter by what the value of the primary object reference of the Task shouldn't be. This"
+ + " results in a substring search (% is appended to the front and end of the "
+ + "requested value). Further SQL \"LIKE\" wildcard characters will be resolved "
+ + "correctly.")
@JsonProperty("por-value-not-like")
private final String[] porValueNotLike;
// endregion
@@ -910,6 +2097,13 @@ public class TaskQueryFilterParameter implements QueryParameter
* specified according to the description of complex parameters in the overview, e.g.
* sor={"value":"exampleValue"}
*/
+ @Schema(
+ name = "sor",
+ description =
+ "Filter by the primary object reference of the Task. This is an exact match. \"sor\" is"
+ + " a parameter of complex type. Its following attributes from sor[].id to "
+ + "sor[].value can be specified according to the description of complex parameters"
+ + " in the overview, e.g. sor={\"value\":\"exampleValue\"}")
@JsonProperty("sor")
private final ObjectReference[] secondaryObjectReferenceIn;
// endregion
@@ -917,6 +2111,11 @@ public class TaskQueryFilterParameter implements QueryParameter
/**
* Filter by the company of the secondary object reference of the Task. This is an exact match.
*/
+ @Schema(
+ name = "sor-company",
+ description =
+ "Filter by the company of the secondary object reference of the Task. This is an exact "
+ + "match.")
@JsonProperty("sor-company")
private final String[] sorCompanyIn;
@@ -925,12 +2124,23 @@ public class TaskQueryFilterParameter implements QueryParameter
* substring search (% is appended to the front and end of the requested value). Further SQL
* "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "sor-company-like",
+ description =
+ "Filter by the company of the secondary object references of the Task. This results in a"
+ + " substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("sor-company-like")
private final String[] sorCompanyLike;
// endregion
// region secondaryObjectReferenceSystem
/** Filter by the system of the secondary object reference of the Task. This is an exact match. */
+ @Schema(
+ name = "sor-system",
+ description =
+ "Filter by the system of the secondary object reference of the Task. This is an exact "
+ + "match.")
@JsonProperty("sor-system")
private final String[] sorSystemIn;
@@ -939,6 +2149,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "sor-system-like",
+ description =
+ "Filter by the system of the secondary object reference of the Task. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("sor-system-like")
private final String[] sorSystemLike;
@@ -948,6 +2164,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by the system instance of the secondary object reference of the Task. This is an exact
* match.
*/
+ @Schema(
+ name = "sor-instance",
+ description =
+ "Filter by the system instance of the secondary object reference of the Task. This is "
+ + "an exact match.")
@JsonProperty("sor-instance")
private final String[] sorInstanceIn;
@@ -956,12 +2177,24 @@ public class TaskQueryFilterParameter implements QueryParameter
* substring search (% is appended to the front and end of the requested value). Further SQL
* "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "sor-instance-like",
+ description =
+ "Filter by the system instance of the secondary object reference of the Task. This "
+ + "results in a substring search (% is appended to the front and end of the "
+ + "requested value). Further SQL \"LIKE\" wildcard characters will be resolved "
+ + "correctly.")
@JsonProperty("sor-instance-like")
private final String[] sorInstanceLike;
// endregion
// region secondaryObjectReferenceSystemType
/** Filter by the type of the secondary object reference of the Task. This is an exact match. */
+ @Schema(
+ name = "sor-type",
+ description =
+ "Filter by the type of the secondary object reference of the Task. This is an exact "
+ + "match.")
@JsonProperty("sor-type")
private final String[] sorTypeIn;
@@ -970,12 +2203,23 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "sor-type-like",
+ description =
+ "Filter by the type of the secondary object reference of the Task. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("sor-type-like")
private final String[] sorTypeLike;
// endregion
// region primaryObjectReferenceSystemValue
/** Filter by the value of the secondary object reference of the Task. This is an exact match. */
+ @Schema(
+ name = "sor-value",
+ description =
+ "Filter by the value of the secondary object reference of the Task. This is an exact "
+ + "match.")
@JsonProperty("sor-value")
private final String[] sorValueIn;
@@ -984,22 +2228,38 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "sor-value-like",
+ description =
+ "Filter by the value of the secondary object reference of the Task. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("sor-value-like")
private final String[] sorValueLike;
// endregion
// region read
/** Filter by the is read flag of the Task. This is an exact match. */
+ @Schema(
+ name = "is-read",
+ description = "Filter by the is read flag of the Task. This is an exact match.")
@JsonProperty("is-read")
private final Boolean isRead;
// endregion
// region transferred
/** Filter by the is transferred flag of the Task. This is an exact match. */
+ @Schema(
+ name = "is-transferred",
+ description = "Filter by the is transferred flag of the Task. This is an exact match.")
@JsonProperty("is-transferred")
private final Boolean isTransferred;
// endregion
// region attachmentClassificationId
/** Filter by the attachment classification id of the Task. This is an exact match. */
+ @Schema(
+ name = "attachment-classification-id",
+ description =
+ "Filter by the attachment classification id of the Task. This is an exact match.")
@JsonProperty("attachment-classification-id")
private final String[] attachmentClassificationIdIn;
@@ -1007,11 +2267,20 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by what the attachment classification id of the Task shouldn't be. This is an exact
* match.
*/
+ @Schema(
+ name = "attachment-classification-id-not",
+ description =
+ "Filter by what the attachment classification id of the Task shouldn't be. This is an "
+ + "exact match.")
@JsonProperty("attachment-classification-id-not")
private final String[] attachmentClassificationIdNotIn;
// endregion
// region attachmentClassificationKey
/** Filter by the attachment classification key of the Task. This is an exact match. */
+ @Schema(
+ name = "attachment-classification-key",
+ description =
+ "Filter by the attachment classification key of the Task. This is an exact match.")
@JsonProperty("attachment-classification-key")
private final String[] attachmentClassificationKeyIn;
@@ -1019,6 +2288,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by what the attachment classification key of the Task shouldn't be. This is an exact
* match.
*/
+ @Schema(
+ name = "attachment-classification-key-not",
+ description =
+ "Filter by what the attachment classification key of the Task shouldn't be. This is an "
+ + "exact match.")
@JsonProperty("attachment-classification-key-not")
private final String[] attachmentClassificationKeyNotIn;
@@ -1027,6 +2301,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "attachment-classification-key-like",
+ description =
+ "Filter by the attachment classification key of the Task. This results in a substring "
+ + "search (% is appended to the front and end of the requested value). Further SQL "
+ + "\"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("attachment-classification-key-like")
private final String[] attachmentClassificationKeyLike;
@@ -1035,11 +2315,21 @@ public class TaskQueryFilterParameter implements QueryParameter
* substring search (% is appended to the front and end of the requested value). Further SQL
* "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "attachment-classification-key-not-like",
+ description =
+ "Filter by what the attachment classification key of the Task shouldn't be. This results"
+ + " in a substring search (% is appended to the front and end of the requested "
+ + "value). Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("attachment-classification-key-not-like")
private final String[] attachmentClassificationKeyNotLike;
// endregion
// region attachmentClassificationName
/** Filter by the attachment classification name of the Task. This is an exact match. */
+ @Schema(
+ name = "attachment-classification-name",
+ description =
+ "Filter by the attachment classification name of the Task. This is an exact match.")
@JsonProperty("attachment-classification-name")
private final String[] attachmentClassificationNameIn;
@@ -1047,6 +2337,11 @@ public class TaskQueryFilterParameter implements QueryParameter
* Filter by what the attachment classification name of the Task shouldn't be. This is an exact
* match.
*/
+ @Schema(
+ name = "attachment-classification-name-not",
+ description =
+ "Filter by what the attachment classification name of the Task shouldn't be. This is an "
+ + "exact match.")
@JsonProperty("attachment-classification-name-not")
private final String[] attachmentClassificationNameNotIn;
@@ -1055,6 +2350,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "attachment-classification-name-like",
+ description =
+ "Filter by the attachment classification name of the Task. This results in a substring "
+ + "search (% is appended to the front and end of the requested value). Further SQL "
+ + "\"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("attachment-classification-name-like")
private final String[] attachmentClassificationNameLike;
@@ -1063,15 +2364,30 @@ public class TaskQueryFilterParameter implements QueryParameter
* substring search (% is appended to the front and end of the requested value). Further SQL
* "LIKE" wildcard characters will be resolved correctly.
*/
+ @Schema(
+ name = "attachment-classification-name-not-like",
+ description =
+ "Filter by what the attachment classification name of the Task shouldn't be. This "
+ + "results in a substring search (% is appended to the front and end of the "
+ + "requested value). Further SQL \"LIKE\" wildcard characters will be resolved "
+ + "correctly.")
@JsonProperty("attachment-classification-name-not-like")
private final String[] attachmentClassificationNameNotLike;
// endregion
// region attachmentChannel
/** Filter by the attachment channel of the Task. This is an exact match. */
+ @Schema(
+ name = "attachment-channel",
+ description = "Filter by the attachment channel of the Task. This is an exact match.")
@JsonProperty("attachment-channel")
private final String[] attachmentChannelIn;
/** Filter by what the attachment channel of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "attachment-channel-not",
+ description =
+ "Filter by what the attachment channel of the Task shouldn't be. This is an exact "
+ + "match.")
@JsonProperty("attachment-channel-not")
private final String[] attachmentChannelNotIn;
@@ -1080,6 +2396,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* to the front and end of the requested value). Further SQL "LIKE" wildcard characters will be
* resolved correctly.
*/
+ @Schema(
+ name = "attachment-channel-like",
+ description =
+ "Filter by the attachment channel of the Task. This results in a substring search (% is "
+ + "appended to the front and end of the requested value). Further SQL \"LIKE\" "
+ + "wildcard characters will be resolved correctly.")
@JsonProperty("attachment-channel-like")
private final String[] attachmentChannelLike;
@@ -1088,15 +2410,29 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "attachment-channel-not-like",
+ description =
+ "Filter by what the attachment channel of the Task shouldn't be. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("attachment-channel-not-like")
private final String[] attachmentChannelNotLike;
// endregion
// region attachmentReferenceValue
/** Filter by the attachment reference of the Task. This is an exact match. */
+ @Schema(
+ name = "attachment-reference",
+ description = "Filter by the attachment reference of the Task. This is an exact match.")
@JsonProperty("attachment-reference")
private final String[] attachmentReferenceIn;
/** Filter by what the attachment reference of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "attachment-reference-not",
+ description =
+ "Filter by what the attachment reference of the Task shouldn't be. This is an exact "
+ + "match.")
@JsonProperty("attachment-reference-not")
private final String[] attachmentReferenceNotIn;
@@ -1105,6 +2441,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* appended to the front and end of the requested value). Further SQL "LIKE" wildcard characters
* will be resolved correctly.
*/
+ @Schema(
+ name = "attachment-reference-like",
+ description =
+ "Filter by the attachment reference of the Task. This results in a substring search (% "
+ + "is appended to the front and end of the requested value). Further SQL \"LIKE\" "
+ + "wildcard characters will be resolved correctly.")
@JsonProperty("attachment-reference-like")
private final String[] attachmentReferenceLike;
@@ -1113,6 +2455,12 @@ public class TaskQueryFilterParameter implements QueryParameter
* search (% is appended to the front and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
+ @Schema(
+ name = "attachment-reference-not-like",
+ description =
+ "Filter by what the attachment reference of the Task shouldn't be. This results in a "
+ + "substring search (% is appended to the front and end of the requested value). "
+ + "Further SQL \"LIKE\" wildcard characters will be resolved correctly.")
@JsonProperty("attachment-reference-not-like")
private final String[] attachmentReferenceNotLike;
// endregion
@@ -1123,6 +2471,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* The format is ISO-8601.
*/
+ @Schema(
+ name = "attachment-received",
+ description =
+ "Filter by a time interval within which the attachment of the Task was received. To "
+ + "create an open interval you can just leave it blank.
The format is ISO-8601.")
@JsonProperty("attachment-received")
private final Instant[] attachmentReceivedWithin;
@@ -1132,6 +2485,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* The format is ISO-8601.
*/
+ @Schema(
+ name = "attachment-received-not",
+ description =
+ "Filter by a time interval within which the attachment of the Task wasn't received. To "
+ + "create an open interval you can just leave it blank.
The format is ISO-8601.")
@JsonProperty("attachment-received-not")
private final Instant[] attachmentReceivedNotWithin;
// endregion
@@ -1140,15 +2498,27 @@ public class TaskQueryFilterParameter implements QueryParameter
* In order to filter Tasks that don't have any Attachments, set 'without-attachment' to 'true'.
* Any other value for 'without-attachment' is invalid.
*/
+ @Schema(
+ name = "without-attachment",
+ description =
+ "In order to filter Tasks that don't have any Attachments, set 'without-attachment' to "
+ + "'true'. Any other value for 'without-attachment' is invalid.")
@JsonProperty("without-attachment")
private final Boolean withoutAttachment;
// endregion
// region callbackState
/** Filter by the callback state of the Task. This is an exact match. */
+ @Schema(
+ name = "callback-state",
+ description = "Filter by the callback state of the Task. This is an exact match.")
@JsonProperty("callback-state")
private final CallbackState[] callbackStateIn;
/** Filter by what the callback state of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "callback-state-not",
+ description =
+ "Filter by what the callback state of the Task shouldn't be. This is an exact match.")
@JsonProperty("callback-state-not")
private final CallbackState[] callbackStateNotIn;
// endregion
@@ -1158,6 +2528,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This must be used in combination with 'wildcard-search-value'
*/
+ @Schema(
+ name = "wildcard-search-fields",
+ description =
+ "Filter by wildcard search field of the Task.
This must be used in combination with "
+ + "'wildcard-search-value'")
@JsonProperty("wildcard-search-fields")
private final WildcardSearchField[] wildcardSearchFieldIn;
@@ -1166,6 +2541,11 @@ public class TaskQueryFilterParameter implements QueryParameter
*
* This must be used in combination with 'wildcard-search-fields'
*/
+ @Schema(
+ name = "wildcard-search-value",
+ description =
+ "Filter by wildcard search field of the Task. This is an exact match.
This must be"
+ + " used in combination with 'wildcard-search-fields'")
@JsonProperty("wildcard-search-value")
private final String wildcardSearchValue;
// endregion
@@ -2203,7 +3583,7 @@ private String[] addNullToOwnerIn() {
return this.ownerIn;
}
if (this.ownerIn == null) {
- return new String[]{null};
+ return new String[] {null};
}
List ownerInAsList = new ArrayList<>(Arrays.asList(this.ownerIn));
ownerInAsList.add(null);
diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryGroupByParameter.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryGroupByParameter.java
index 40c21f0217..4ca08f3fa7 100644
--- a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryGroupByParameter.java
+++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryGroupByParameter.java
@@ -1,6 +1,7 @@
package pro.taskana.task.rest;
import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
import java.beans.ConstructorProperties;
import java.util.Optional;
import java.util.function.Consumer;
@@ -22,11 +23,25 @@ public void applyGroupByForQuery(TaskQuery query) {
}
}
+ public String getGroupBySor() {
+ return groupBySor;
+ }
+
+ public TaskQueryGroupBy getGroupByPor() {
+ return groupByPor;
+ }
+
// region groupBy
@JsonProperty("group-by")
+ @Schema(
+ name = "group-by"
+ )
private final TaskQueryGroupBy groupByPor;
@JsonProperty("group-by-sor")
+ @Schema(
+ name = "group-by-sor"
+ )
private final String groupBySor;
// endregion
diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketController.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketController.java
index dd4a9d09ef..364046fb3f 100644
--- a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketController.java
+++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketController.java
@@ -1,11 +1,20 @@
package pro.taskana.workbasket.rest;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
import jakarta.servlet.http.HttpServletRequest;
import java.beans.ConstructorProperties;
import java.util.List;
import java.util.function.BiConsumer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import org.springdoc.core.annotations.ParameterObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.hateoas.MediaTypes;
import org.springframework.hateoas.config.EnableHypermediaSupport;
@@ -89,13 +98,30 @@ public class WorkbasketController {
* @param pagingParameter the paging parameters
* @return the Workbaskets with the given filter, sort and paging options.
*/
+ @Operation(
+ summary = "Get a list of all Workbaskets",
+ description =
+ "This endpoint retrieves a list of existing Workbaskets. Filters can be applied.",
+ parameters = {@Parameter(name = "type", example = "PERSONAL")})
+ @ApiResponses(
+ value = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "Found all Workbaskets",
+ content = {
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema =
+ @Schema(implementation = WorkbasketSummaryPagedRepresentationModel.class))
+ }),
+ })
@GetMapping(path = RestEndpoints.URL_WORKBASKET)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity getWorkbaskets(
HttpServletRequest request,
- WorkbasketQueryFilterParameter filterParameter,
- WorkbasketQuerySortParameter sortParameter,
- QueryPagingParameter pagingParameter) {
+ @ParameterObject WorkbasketQueryFilterParameter filterParameter,
+ @ParameterObject WorkbasketQuerySortParameter sortParameter,
+ @ParameterObject QueryPagingParameter pagingParameter) {
QueryParamsValidator.validateParams(
request,
@@ -125,6 +151,26 @@ public ResponseEntity getWorkbaskets(
* @throws NotAuthorizedOnWorkbasketException if the current user has no permissions to access the
* requested Workbasket
*/
+ @Operation(
+ summary = "Get a single Workbasket",
+ description = "This endpoint retrieves a single Workbasket.",
+ parameters = {
+ @Parameter(
+ name = "workbasketId",
+ description = "the Id of the requested Workbasket",
+ required = true,
+ example = "WBI:100000000000000000000000000000000001")
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "the requested Workbasket",
+ content = {
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = WorkbasketRepresentationModel.class))
+ })
+ })
@GetMapping(path = RestEndpoints.URL_WORKBASKET_ID, produces = MediaTypes.HAL_JSON_VALUE)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity getWorkbasket(
@@ -157,6 +203,35 @@ public ResponseEntity getWorkbasket(
* @throws WorkbasketInUseException if the Workbasket contains tasks.
* @throws NotAuthorizedException if the current user has not correct permissions
*/
+ @Operation(
+ summary = "Delete a Workbasket",
+ description = "This endpoint deletes an existing Workbasket",
+ parameters = {
+ @Parameter(
+ name = "workbasketId",
+ description = "the Id of the requested Workbasket",
+ required = true,
+ example = "WBI:100000000000000000000000000000000002")
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "204",
+ description = "204 NO_CONTENT - Workbasket has been deleted successfully",
+ content = @Content(schema = @Schema())),
+ @ApiResponse(
+ responseCode = "202",
+ description =
+ "202 ACCEPTED - Workbasket still contains completed Tasks. It has been "
+ + "marked for deletion and will be deleted automatically as soon as all "
+ + "completed Tasks are deleted.",
+ content = @Content(schema = @Schema())),
+ @ApiResponse(
+ responseCode = "423",
+ description =
+ "423 LOCKED - Workbasket contains non-completed Tasks and cannot be "
+ + "deleted.",
+ content = @Content(schema = @Schema()))
+ })
@DeleteMapping(path = RestEndpoints.URL_WORKBASKET_ID)
@Transactional(rollbackFor = Exception.class, noRollbackFor = WorkbasketNotFoundException.class)
public ResponseEntity deleteWorkbasket(
@@ -195,6 +270,35 @@ public ResponseEntity deleteWorkbasket(
* @throws WorkbasketAlreadyExistException if the Workbasket exists already
* @throws DomainNotFoundException if the domain does not exist in the configuration.
*/
+ @Operation(
+ summary = "Create a new Workbasket",
+ description = "This endpoint creates a persistent Workbasket.",
+ requestBody =
+ @io.swagger.v3.oas.annotations.parameters.RequestBody(
+ description = "the Workbasket which should be created.",
+ content =
+ @Content(
+ schema = @Schema(implementation = WorkbasketRepresentationModel.class),
+ examples =
+ @ExampleObject(
+ value =
+ "{\n"
+ + " \"key\" : \"asdasdasd\",\n"
+ + " \"name\" : \"this is a wonderful workbasket name\",\n"
+ + " \"domain\" : \"DOMAIN_A\",\n"
+ + " \"type\" : \"GROUP\",\n"
+ + " \"markedForDeletion\" : false\n"
+ + "}"))),
+ responses = {
+ @ApiResponse(
+ responseCode = "201",
+ description = "the created Workbasket",
+ content = {
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = WorkbasketRepresentationModel.class))
+ })
+ })
@PostMapping(path = RestEndpoints.URL_WORKBASKET)
@Transactional(rollbackFor = Exception.class)
public ResponseEntity createWorkbasket(
@@ -226,6 +330,60 @@ public ResponseEntity createWorkbasket(
* updated it already
* @throws NotAuthorizedOnWorkbasketException if the current user has not correct permissions
*/
+ @Operation(
+ summary = "Update a Workbasket",
+ description = "This endpoint creates a persistent Workbasket.",
+ parameters = {
+ @Parameter(
+ name = "workbasketId",
+ description = "the Id of the requested Workbasket",
+ required = true,
+ example = "WBI:100000000000000000000000000000000001")
+ },
+ requestBody =
+ @io.swagger.v3.oas.annotations.parameters.RequestBody(
+ description = "the new Workbasket for the requested id",
+ content =
+ @Content(
+ schema = @Schema(implementation = WorkbasketRepresentationModel.class),
+ examples =
+ @ExampleObject(
+ value =
+ "{\n"
+ + " \"workbasketId\" : "
+ + "\"WBI:100000000000000000000000000000000001\",\n"
+ + " \"key\" : \"GPK_KSC\",\n"
+ + " \"name\" : \"new name\",\n"
+ + " \"domain\" : \"DOMAIN_A\",\n"
+ + " \"type\" : \"GROUP\",\n"
+ + " \"description\" : \"Gruppenpostkorb KSC\",\n"
+ + " \"owner\" : \"teamlead-1\",\n"
+ + " \"custom1\" : \"ABCQVW\",\n"
+ + " \"custom2\" : \"\",\n"
+ + " \"custom3\" : \"xyz4\",\n"
+ + " \"custom4\" : \"\",\n"
+ + " \"custom5\" : \"\",\n"
+ + " \"custom6\" : \"\",\n"
+ + " \"custom7\" : \"\",\n"
+ + " \"custom8\" : \"\",\n"
+ + " \"orgLevel1\" : \"\",\n"
+ + " \"orgLevel2\" : \"\",\n"
+ + " \"orgLevel3\" : \"\",\n"
+ + " \"orgLevel4\" : \"\",\n"
+ + " \"markedForDeletion\" : false,\n"
+ + " \"created\" : \"2018-02-01T12:00:00.000Z\",\n"
+ + " \"modified\" : \"2018-02-01T12:00:00.000Z\"\n"
+ + "}"))),
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "the requested Workbasket",
+ content = {
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = WorkbasketRepresentationModel.class))
+ })
+ })
@PutMapping(path = RestEndpoints.URL_WORKBASKET_ID)
@Transactional(rollbackFor = Exception.class)
public ResponseEntity updateWorkbasket(
@@ -262,6 +420,28 @@ public ResponseEntity updateWorkbasket(
* @throws WorkbasketNotFoundException if the requested Workbasket does not exist.
* @throws NotAuthorizedOnWorkbasketException if the current user has not correct permissions
*/
+ @Operation(
+ summary = "Get all Workbasket Access Items",
+ description = "This endpoint retrieves all Workbasket Access Items for a given Workbasket.",
+ parameters = {
+ @Parameter(
+ name = "workbasketId",
+ description = "the Id of the requested Workbasket",
+ required = true,
+ example = "WBI:100000000000000000000000000000000001")
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "the access items for the requested Workbasket.",
+ content = {
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema =
+ @Schema(
+ implementation = WorkbasketAccessItemCollectionRepresentationModel.class))
+ })
+ })
@GetMapping(
path = RestEndpoints.URL_WORKBASKET_ID_ACCESS_ITEMS,
produces = MediaTypes.HAL_JSON_VALUE)
@@ -295,6 +475,69 @@ public ResponseEntity getWork
* in the provided list.
* @throws NotAuthorizedOnWorkbasketException if the current user has not correct permissions
*/
+ @Operation(
+ summary = "Set all Workbasket Access Items",
+ description =
+ "This endpoint replaces all Workbasket Access Items for a given Workbasket with the "
+ + "provided",
+ parameters = {
+ @Parameter(
+ name = "workbasketId",
+ description = "the Id of the Workbasket whose Workbasket Access Items will be replaced",
+ required = true,
+ example = "WBI:100000000000000000000000000000000001")
+ },
+ requestBody =
+ @io.swagger.v3.oas.annotations.parameters.RequestBody(
+ description = "the new Workbasket Access Items.",
+ content =
+ @Content(
+ schema =
+ @Schema(
+ implementation =
+ WorkbasketAccessItemCollectionRepresentationModel.class),
+ examples =
+ @ExampleObject(
+ value =
+ "{\n"
+ + " \"accessItems\" : [ {\n"
+ + " \"workbasketId\" : "
+ + "\"WBI:100000000000000000000000000000000001\",\n"
+ + " \"accessId\" : \"new-access-id\",\n"
+ + " \"accessName\" : \"new-access-name\",\n"
+ + " \"permRead\" : false,\n"
+ + " \"permReadTasks\" : false,\n"
+ + " \"permOpen\" : true,\n"
+ + " \"permAppend\" : false,\n"
+ + " \"permEditTasks\" : false,\n"
+ + " \"permTransfer\" : false,\n"
+ + " \"permDistribute\" : false,\n"
+ + " \"permCustom1\" : false,\n"
+ + " \"permCustom2\" : false,\n"
+ + " \"permCustom3\" : false,\n"
+ + " \"permCustom4\" : false,\n"
+ + " \"permCustom5\" : false,\n"
+ + " \"permCustom6\" : false,\n"
+ + " \"permCustom7\" : false,\n"
+ + " \"permCustom8\" : false,\n"
+ + " \"permCustom9\" : false,\n"
+ + " \"permCustom10\" : false,\n"
+ + " \"permCustom11\" : false,\n"
+ + " \"permCustom12\" : false\n"
+ + " } ]\n"
+ + "}"))),
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "the new Workbasket Access Items for the requested Workbasket",
+ content = {
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema =
+ @Schema(
+ implementation = WorkbasketAccessItemCollectionRepresentationModel.class))
+ })
+ })
@PutMapping(path = RestEndpoints.URL_WORKBASKET_ID_ACCESS_ITEMS)
@Transactional(rollbackFor = Exception.class)
public ResponseEntity setWorkbasketAccessItems(
@@ -332,6 +575,28 @@ public ResponseEntity setWork
* @throws NotAuthorizedOnWorkbasketException if the current user has no read permission for the
* specified Workbasket
*/
+ @Operation(
+ summary = "Get all Distribution Targets for a Workbasket",
+ description = "This endpoint retrieves all Distribution Targets for a requested Workbasket.",
+ parameters = {
+ @Parameter(
+ name = "workbasketId",
+ description = "the Id of the Workbasket whose Distribution Targets will be retrieved",
+ required = true,
+ example = "WBI:100000000000000000000000000000000002")
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "the Distribution Targets for the requested Workbasket",
+ content = {
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema =
+ @Schema(
+ implementation = DistributionTargetsCollectionRepresentationModel.class))
+ })
+ })
@GetMapping(
path = RestEndpoints.URL_WORKBASKET_ID_DISTRIBUTION,
produces = MediaTypes.HAL_JSON_VALUE)
@@ -359,6 +624,41 @@ public ResponseEntity getDistr
* the source Workbasket
* @throws NotAuthorizedException if the current user has not correct permissions
*/
+ @Operation(
+ summary = "Set all Distribution Targets for a Workbasket",
+ description =
+ "This endpoint replaces all Distribution Targets for a given Workbasket with the "
+ + "provided ones.",
+ parameters = {
+ @Parameter(
+ name = "workbasketId",
+ description = "the source Workbasket",
+ required = true,
+ example = "WBI:100000000000000000000000000000000001")
+ },
+ requestBody =
+ @io.swagger.v3.oas.annotations.parameters.RequestBody(
+ description = "the destination Workbaskets.",
+ content =
+ @Content(
+ array = @ArraySchema(schema = @Schema(implementation = String.class)),
+ examples =
+ @ExampleObject(
+ value =
+ "[ \"WBI:100000000000000000000000000000000002\", "
+ + "\"WBI:100000000000000000000000000000000003\" ]"))),
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "the new Distribution Targets for the requested Workbasket.",
+ content = {
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema =
+ @Schema(
+ implementation = DistributionTargetsCollectionRepresentationModel.class))
+ })
+ })
@PutMapping(path = RestEndpoints.URL_WORKBASKET_ID_DISTRIBUTION)
@Transactional(rollbackFor = Exception.class)
public ResponseEntity
@@ -388,6 +688,17 @@ public ResponseEntity getDistr
* @throws NotAuthorizedException if the requested user ist not ADMIN or BUSINESS_ADMIN.
* @throws NotAuthorizedOnWorkbasketException if the current user has not correct permissions
*/
+ @Operation(
+ summary = "Remove a Workbasket as Distribution Target",
+ description =
+ "This endpoint removes all Distribution Target references for a provided Workbasket.",
+ parameters = {
+ @Parameter(
+ name = "workbasketId",
+ description = "the Id of the requested Workbasket.",
+ required = true,
+ example = "WBI:100000000000000000000000000000000007")
+ })
@DeleteMapping(path = RestEndpoints.URL_WORKBASKET_ID_DISTRIBUTION)
@Transactional(rollbackFor = Exception.class)
public ResponseEntity removeDistributionTargetForWorkbasketId(
diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketQueryFilterParameter.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketQueryFilterParameter.java
index df65d82158..3d0743dc71 100644
--- a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketQueryFilterParameter.java
+++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketQueryFilterParameter.java
@@ -1,6 +1,7 @@
package pro.taskana.workbasket.rest;
import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
import java.beans.ConstructorProperties;
import java.util.Optional;
import pro.taskana.common.rest.QueryParameter;
@@ -11,6 +12,9 @@
public class WorkbasketQueryFilterParameter implements QueryParameter {
/** Filter by the name of the Workbasket. This is an exact match. */
+ @Schema(
+ name = "name",
+ description = "Filter by the name of the Workbasket. This is an exact match.")
@JsonProperty("name")
private final String[] name;
@@ -19,10 +23,19 @@ public class WorkbasketQueryFilterParameter implements QueryParameter getContent() {
return super.getContent();
diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketRepresentationModel.java
index a3319ca5a9..64903f380c 100644
--- a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketRepresentationModel.java
+++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketRepresentationModel.java
@@ -1,5 +1,6 @@
package pro.taskana.workbasket.rest.models;
+import io.swagger.v3.oas.annotations.media.Schema;
import java.time.Instant;
import pro.taskana.workbasket.api.models.Workbasket;
@@ -11,12 +12,21 @@ public class WorkbasketRepresentationModel extends WorkbasketSummaryRepresentati
*
* The format is ISO-8601.
*/
+ @Schema(
+ name = "created",
+ description =
+ "The creation timestamp of the workbasket in the system. The format is ISO-8601.")
private Instant created;
+
/**
* The timestamp of the last modification.
*
*
The format is ISO-8601.
*/
+ @Schema(
+ name = "modified",
+ description =
+ "The timestamp of the last modification. The format is ISO-8601.")
private Instant modified;
public Instant getCreated() {
diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketSummaryRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketSummaryRepresentationModel.java
index edd24e4f71..b2d0843083 100644
--- a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketSummaryRepresentationModel.java
+++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketSummaryRepresentationModel.java
@@ -1,5 +1,6 @@
package pro.taskana.workbasket.rest.models;
+import io.swagger.v3.oas.annotations.media.Schema;
import org.springframework.hateoas.RepresentationModel;
import pro.taskana.workbasket.api.WorkbasketType;
import pro.taskana.workbasket.api.models.WorkbasketSummary;
@@ -9,38 +10,72 @@ public class WorkbasketSummaryRepresentationModel
extends RepresentationModel {
/** Unique Id. */
+ @Schema(name = "workbasketId", description = "Unique Id.")
protected String workbasketId;
+
/** the professional key for the workbasket. */
+ @Schema(name = "key", description = "the professional key for the workbasket.")
protected String key;
+
/** The name of the workbasket. */
+ @Schema(name = "name", description = "The name of the workbasket.")
protected String name;
+
/** The domain the workbasket belongs to. */
+ @Schema(name = "domain", description = "The domain the workbasket belongs to.")
protected String domain;
+
/** The type of the workbasket. */
+ @Schema(name = "type", description = "The type of the workbasket.")
protected WorkbasketType type;
+
/** the description of the workbasket. */
+ @Schema(name = "description", description = "the description of the workbasket.")
protected String description;
+
/**
* The owner of the workbasket. The owner is responsible for the on-time completion of all tasks
* in the workbasket.
*/
+ @Schema(
+ name = "owner",
+ description =
+ "The owner of the workbasket. The owner is responsible for the on-time completion of "
+ + "all tasks in the workbasket.")
protected String owner;
+
/** A custom property with name "1". */
+ @Schema(name = "custom1", description = "A custom property with name \"1\".")
protected String custom1;
+
/** A custom property with name "2". */
+ @Schema(name = "custom2", description = "A custom property with name \"2\".")
protected String custom2;
+
/** A custom property with name "3". */
+ @Schema(name = "custom3", description = "A custom property with name \"3\".")
protected String custom3;
+
/** A custom property with name "4". */
+ @Schema(name = "custom4", description = "A custom property with name \"4\".")
protected String custom4;
+
/** A custom property with name "5". */
+ @Schema(name = "custom5", description = "A custom property with name \"5\".")
protected String custom5;
+
/** A custom property with name "6". */
+ @Schema(name = "custom6", description = "A custom property with name \"6\".")
protected String custom6;
+
/** A custom property with name "7". */
+ @Schema(name = "custom7", description = "A custom property with name \"7\".")
protected String custom7;
+
/** A custom property with name "8". */
+ @Schema(name = "custom8", description = "A custom property with name \"8\".")
protected String custom8;
+
/**
* The first Org Level (the top one).
*
@@ -48,13 +83,27 @@ public class WorkbasketSummaryRepresentationModel
* are used for monitoring and statistical purposes and should reflect who is responsible of the
* tasks in the workbasket.
*/
+ @Schema(
+ name = "orgLevel1",
+ description =
+ "The first Org Level (the top one).The Org Level is an association with an org "
+ + "hierarchy level in the organization. The values are used for monitoring and "
+ + "statistical purposes and should reflect who is responsible of the tasks in the"
+ + " workbasket.")
protected String orgLevel1;
+
/** The second Org Level. */
+ @Schema(name = "orgLevel2", description = "The second Org Level.")
protected String orgLevel2;
+
/** The third Org Level. */
+ @Schema(name = "orgLevel3", description = "The third Org Level.")
protected String orgLevel3;
+
/** The fourth Org Level (the lowest one). */
+ @Schema(name = "orgLevel4", description = "The fourth Org Level.")
protected String orgLevel4;
+
/** Identifier to tell if this workbasket can be deleted. */
private boolean markedForDeletion;