You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: help/hygiene/api/workorder.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -295,7 +295,7 @@ The following table describes the properties in the response.
295
295
>
296
296
>The action property for record delete work orders is currently `identity-delete` in API responses. If the API changes to use a different value (such as `delete_identity`), this documentation will be updated accordingly.
297
297
298
-
## Generate JSON payloads for identity-delete requests
298
+
## Convert ID lists to JSON for record delete requests
299
299
300
300
To create a record delete work order from CSV, TSV, or TXT files containing identifiers, you can use conversion scripts to produce the required JSON payloads for the `/workorder` endpoint. This approach is especially helpful when working with existing data files. For ready-to-use scripts and comprehensive instructions, visit the [csv-to-data-hygiene GitHub repository](https://github.com/perlmonger42/csv-to-data-hygiene).
301
301
@@ -345,11 +345,13 @@ done
345
345
346
346
>[!ENDTABS]
347
347
348
+
The table below describes the parameters in the bash scripts.
349
+
348
350
| Parameter | Description |
349
351
| --- | --- |
350
352
|`verbose`| Enable verbose output. |
351
-
|`column`|Column index (1-based) or name. Defaults to the first column. |
352
-
|`namespace`| An object with a `code` property specifying the identity namespace (e.g., "email"). |
353
+
|`column`|The index (1-based) or header name of the column containing the identity values to delete. Defaults to the first column if not specified. |
354
+
|`namespace`| An object with a `code` property specifying the identity namespace (for example, "email"). |
353
355
|`dataset-id`| The unique identifier for the dataset associated with the work order. If the request applies to all datasets, this field will be set to ALL. |
354
356
|`description`| A description of the record delete work order. |
355
357
|`output-dir`| The directory to write the output JSON payload. |
@@ -389,13 +391,13 @@ The following table describes the properties in the JSON payload.
389
391
|`datasetId`| The unique identifier for the dataset. |
390
392
|`displayName`| A human-readable label for this record delete work order. |
391
393
|`description`| A description of the record delete work order. |
392
-
|`identities`| An array of objects, each containing:<br><ul><li> `namespace`: An object with a `code` property specifying the identity namespace (e.g., "email").</li><li> `id`: The identity value to delete for this namespace.</li></ul> |
394
+
|`identities`| An array of objects, each containing:<br><ul><li> `namespace`: An object with a `code` property specifying the identity namespace (for example, "email").</li><li> `id`: The identity value to delete for this namespace.</li></ul> |
393
395
394
396
{style="table-layout:auto"}
395
397
396
398
**Submit the generated JSON data to the `/workorder` endpoint**
397
399
398
-
For submission, follow the guideline in [Create a record delete work order](https://experienceleague.adobe.com/en/docs/experience-platform/data-lifecycle/api/workorder#create). Use the converted JSON payload as the `-d` value when sending your `curl` POST request to the `/workorder` API endpoint.
400
+
For submission, please follow the guideline in the [create a record delete work order](#create) section. Make sure to use the converted JSON payload as the `-d` value when sending your `curl` POST request to the `/workorder` API endpoint.
399
401
400
402
## Retrieve details for a specific record delete work order {#lookup}
0 commit comments