Skip to content

Commit

Permalink
fix: remove draft field from task search response
Browse files Browse the repository at this point in the history
  • Loading branch information
@panagiotisgts
panagiotisgts committed Jun 11, 2024
1 parent 20cb5d2 commit 0ceb295
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 18 deletions.
8 changes: 2 additions & 6 deletions docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,9 @@ On success returned.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique identifier of the task."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the task."}}></SchemaItem><SchemaItem collapsible={false} name={"taskDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User Task ID from the BPMN definition."}}></SchemaItem><SchemaItem collapsible={false} name={"processName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the process."}}></SchemaItem><SchemaItem collapsible={false} name={"creationDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"When was the task created (renamed equivalent of `Task.creationTime` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"completionDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"When was the task completed (renamed equivalent of `Task.completionTime` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"assignee"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The username/id of who is assigned to the task."}}></SchemaItem><SchemaItem collapsible={false} name={"taskState"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CREATED`, `COMPLETED`, `CANCELED`, `FAILED`]"} schema={{"type":"string","description":"The state of the task.","enum":["CREATED","COMPLETED","CANCELED","FAILED"]}}></SchemaItem><SchemaItem collapsible={false} name={"sortValues"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Array of values to be copied into `TaskSearchRequest` to request for next or previous page of tasks.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"isFirst"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"A flag to show that the task is first in the current filter."}}></SchemaItem><SchemaItem collapsible={false} name={"formKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to the task form."}}></SchemaItem><SchemaItem collapsible={false} name={"formId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to the ID of a deployed form. If the form is not deployed, this property is null."}}></SchemaItem><SchemaItem collapsible={false} name={"formVersion"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"Reference to the version of a deployed form. If the form is not deployed, this property is null.","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"isFormEmbedded"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Is the form embedded for this task? If there is no form, this property is null."}}></SchemaItem><SchemaItem collapsible={false} name={"processDefinitionKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to process definition (renamed equivalent of `Task.processDefinitionId` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"processInstanceKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reference to process instance id (renamed equivalent of `Task.processInstanceId` field)."}}></SchemaItem><SchemaItem collapsible={false} name={"tenantId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The tenant ID associated with the task."}}></SchemaItem><SchemaItem collapsible={false} name={"dueDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The due date for the task.","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"followUpDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The follow-up date for the task.","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"candidateGroups"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The candidate groups for the task.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"candidateUsers"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The candidate users for the task.","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>variables</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned. Note that a variable's draft value is not returned in `TaskSearchResponse`.
An array of the task's variables. Only variables specified in `TaskSearchRequest.includeVariables` are returned.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique identifier of the variable."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the variable."}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The value of the variable."}}></SchemaItem><SchemaItem collapsible={false} name={"isValueTruncated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Does the `previewValue` contain the truncated value or full value?"}}></SchemaItem><SchemaItem collapsible={false} name={"previewValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A preview of the variable's value. Limited in size."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>draft</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The draft value of the variable.

</div><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The value of the variable."}}></SchemaItem><SchemaItem collapsible={false} name={"isValueTruncated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Does the `previewValue` contain the truncated value or full value?"}}></SchemaItem><SchemaItem collapsible={false} name={"previewValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A preview of the variable's value. Limited in size."}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"implementation"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`JOB_WORKER`, `ZEEBE_USER_TASK`]"} schema={{"type":"string","enum":["JOB_WORKER","ZEEBE_USER_TASK"]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"taskDefinitionId\": \"string\",\n \"processName\": \"string\",\n \"creationDate\": \"string\",\n \"completionDate\": \"string\",\n \"assignee\": \"string\",\n \"taskState\": \"CREATED\",\n \"sortValues\": [\n \"string\"\n ],\n \"isFirst\": true,\n \"formKey\": \"string\",\n \"formId\": \"string\",\n \"formVersion\": 0,\n \"isFormEmbedded\": true,\n \"processDefinitionKey\": \"string\",\n \"processInstanceKey\": \"string\",\n \"tenantId\": \"string\",\n \"dueDate\": \"2024-04-03T03:24:08.865Z\",\n \"followUpDate\": \"2024-04-03T03:24:08.865Z\",\n \"candidateGroups\": [\n \"string\"\n ],\n \"candidateUsers\": [\n \"string\"\n ],\n \"variables\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": \"string\",\n \"isValueTruncated\": true,\n \"previewValue\": \"string\",\n \"draft\": {\n \"value\": \"string\",\n \"isValueTruncated\": true,\n \"previewValue\": \"string\"\n }\n }\n ],\n \"implementation\": \"JOB_WORKER\"\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique identifier of the variable."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the variable."}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The value of the variable."}}></SchemaItem><SchemaItem collapsible={false} name={"isValueTruncated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Does the `previewValue` contain the truncated value or full value?"}}></SchemaItem><SchemaItem collapsible={false} name={"previewValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A preview of the variable's value. Limited in size."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"implementation"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`JOB_WORKER`, `ZEEBE_USER_TASK`]"} schema={{"type":"string","enum":["JOB_WORKER","ZEEBE_USER_TASK"]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"taskDefinitionId\": \"string\",\n \"processName\": \"string\",\n \"creationDate\": \"string\",\n \"completionDate\": \"string\",\n \"assignee\": \"string\",\n \"taskState\": \"CREATED\",\n \"sortValues\": [\n \"string\"\n ],\n \"isFirst\": true,\n \"formKey\": \"string\",\n \"formId\": \"string\",\n \"formVersion\": 0,\n \"isFormEmbedded\": true,\n \"processDefinitionKey\": \"string\",\n \"processInstanceKey\": \"string\",\n \"tenantId\": \"string\",\n \"dueDate\": \"2024-04-03T03:24:08.865Z\",\n \"followUpDate\": \"2024-04-03T03:24:08.865Z\",\n \"candidateGroups\": [\n \"string\"\n ],\n \"candidateUsers\": [\n \"string\"\n ],\n \"variables\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": \"string\",\n \"isValueTruncated\": true,\n \"previewValue\": \"string\",\n \"draft\": {\n \"value\": \"string\",\n \"isValueTruncated\": true,\n \"previewValue\": \"string\"\n }\n }\n ],\n \"implementation\": \"JOB_WORKER\"\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

An error is returned when more than one search parameters among `[searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual]` are present in request

Expand Down
Loading

0 comments on commit 0ceb295

Please sign in to comment.