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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -299,7 +299,7 @@ The following table describes the properties in the response.
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
302
-
**Generate JSON payloads**
302
+
### Generate JSON payloads
303
303
304
304
The following bash script examples demonstrate how to run the conversion scripts in Python or Ruby:
305
305
@@ -352,13 +352,13 @@ The table below describes the parameters in the bash scripts.
352
352
|`verbose`| Enable verbose output. |
353
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
354
|`namespace`| An object with a `code` property specifying the identity namespace (for example, "email"). |
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. |
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`. |
356
356
|`description`| A description of the record delete work order. |
357
357
|`output-dir`| The directory to write the output JSON payload. |
358
358
359
359
{style="table-layout:auto"}
360
360
361
-
A successful JSON payload converted from CSV, TSV, or TXT files contains the records associated with the specified namespace, for example email address.
361
+
The example below shows a successful JSON payload converted from a CSV, TSV, or TXT file. It contains records associated with the specified namespace and is used to delete records identified by email addresses.
362
362
363
363
```json
364
364
{
@@ -395,9 +395,9 @@ The following table describes the properties in the JSON payload.
395
395
396
396
{style="table-layout:auto"}
397
397
398
-
**Submit the generated JSON data to the `/workorder` endpoint**
398
+
### Submit the generated JSON data to the `/workorder` endpoint
399
399
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.
400
+
To submit a request, follow the instructions in the [create a record delete work order](#create) section. Make sure to use the converted JSON payload as the request body (`-d`) when sending your `curl` POST request to the `/workorder` API endpoint.
401
401
402
402
## Retrieve details for a specific record delete work order {#lookup}
0 commit comments