Skip to content

Commit 51b382a

Browse files
authored
fix(docs): correct property names for filtering tasks in API documentation (#1103)
Co-authored-by: Paul Chasle <[email protected]>
1 parent d8598f8 commit 51b382a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

content/rest-api/filter.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2139,14 +2139,14 @@ In the above url :
21392139
To only retrieve tasks on specified products, you can use the following URL.
21402140

21412141
```
2142-
/api/rest/v1/workflows/tasks?search={"product_uuids":[{"operator":"IN","value":["9c8fc7b2-9039-4c22-970e-643939b54fad"]}]}
2142+
/api/rest/v1/workflows/tasks?search={"product_uuid":[{"operator":"IN","value":["9c8fc7b2-9039-4c22-970e-643939b54fad"]}]}
21432143
```
21442144

21452145
### On their task uuid
21462146

21472147
::: availability versions=SaaS editions=EE
21482148

2149-
To filter tasks on their uuids, use the `task_uuids` property.
2149+
To filter tasks on their uuids, use the `task_uuid` property.
21502150
Here are the allowed operators you can use to filter on the task uuid as well as the corresponding type of value expected in the `search` query parameter.
21512151

21522152
| Allowed operators | Allowed value type |
@@ -2156,14 +2156,14 @@ Here are the allowed operators you can use to filter on the task uuid as well as
21562156
#### Example
21572157

21582158
```
2159-
/api/rest/v1/workflows/tasks?search={"task_uuids":[{"operator":"IN","value":["9c8fc7b2-9039-4c22-970e-643939b54fad", "b1c8f7a2-9039-4c22-970e-643939b54fad"]}]}
2159+
/api/rest/v1/workflows/tasks?search={"task_uuid":[{"operator":"IN","value":["9c8fc7b2-9039-4c22-970e-643939b54fad", "b1c8f7a2-9039-4c22-970e-643939b54fad"]}]}
21602160
```
21612161

21622162
### On their product uuid
21632163

21642164
::: availability versions=SaaS editions=EE
21652165

2166-
To filter tasks on their product uuids, use the `product_uuids` property.
2166+
To filter tasks on their product uuids, use the `product_uuid` property.
21672167
Here are the allowed operators you can use to filter on the product uuid as well as the corresponding type of value expected in the `search` query parameter.
21682168

21692169
| Allowed operators | Allowed value type |
@@ -2173,14 +2173,14 @@ Here are the allowed operators you can use to filter on the product uuid as well
21732173
#### Example
21742174

21752175
```
2176-
/api/rest/v1/workflows/tasks?search={"product_uuids":[{"operator":"IN","value":["9c8fc7b2-9039-4c22-970e-643939b54fad", "b1c8f7a2-9039-4c22-970e-643939b54fad"]}]}
2176+
/api/rest/v1/workflows/tasks?search={"product_uuid":[{"operator":"IN","value":["9c8fc7b2-9039-4c22-970e-643939b54fad", "b1c8f7a2-9039-4c22-970e-643939b54fad"]}]}
21772177
```
21782178

21792179
### On their product model code
21802180

21812181
::: availability versions=SaaS editions=EE
21822182

2183-
To filter tasks on their product model codes, use the `product_model_codes` property.
2183+
To filter tasks on their product model codes, use the `product_model_code` property.
21842184
Here are the allowed operators you can use to filter on the product model code as well as the corresponding type of value expected in the `search` query parameter.
21852185

21862186
| Allowed operators | Allowed value type |
@@ -2190,5 +2190,5 @@ Here are the allowed operators you can use to filter on the product model code a
21902190
#### Example
21912191

21922192
```
2193-
/api/rest/v1/workflows/tasks?search={"product_model_codes":[{"operator":"IN","value":["amor", "apollon"]}]}
2193+
/api/rest/v1/workflows/tasks?search={"product_model_code":[{"operator":"IN","value":["amor", "apollon"]}]}
21942194
```

0 commit comments

Comments
 (0)