Delete Context Records Action | Industries Common Resources Developer Guide

This action is available in API version 67.0 and later.

Special Access Rules

Available in Developer, Enterprise, Professional, and Unlimited editions for Industries clouds where Context Service is enabled.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/deleteContextRecords

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

Input	Type	Description
contextId	string	Required. ID of the context instance from which records are deleted.
dataPaths	List<String>	Required. A collection of data path objects that identify the records to delete from the context instance. Each object contains a `dataPath` field whose value is a list of strings representing the hierarchical path from the root to the target record in the context.
isPermanentDelete	boolean	Optional. Indicates whether the record is permanently deleted (`true`) or not (`false`). The default value is `false`.

Usage

Use this action to delete one or more records from a context instance. By default, records are soft deleted. To permanently delete the records, set isPermanentDelete to true.

Example

POST

This sample request is for the Delete Context Records action.

1{
2  "inputs": [
3    {
4      "contextId": "0000000a07da091002517526756248297be68492e6b442e8ad80182d518e45aa",
5      "dataPaths": [
6        { "dataPath": ["001xx000003GbMhAAK", "003xx000004Wia5AAC"] }
7      ],
8      "isPermanentDelete": false
9    }
10  ]
11}

This sample response is for the Delete Context Records action.

1[
2  {
3    "actionName": "deleteContextRecords",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": {}
7  }
8]