Extraction Context Mappings (DELETE, GET, PATCH)

Delete extraction context mapping details based on the specified context use case mapping ID. Get extraction context mapping details based on the specified context use case mapping ID. Update extraction context mapping details based on the specified context use case mapping ID.

Resource

1/connect/clm/extraction-context-mappings/${contextUseCaseMappingId}

Available Version

61.0

HTTP Methods

DELETE GET PATCH

Example for DELETE

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/clm/extraction-context-mappings/11jSB000002XTWjYAO

Example for GET

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/clm/extraction-context-mappings/11jSB000002XTWjYAO

Example for PATCH

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/clm/extraction-context-mappings/11jSB000002XTWjYAO

Response Body for GET

Extraction Context Mapping

Request Body for PATCH

JSON Example

1{
2  "ContextUsecaseMapping": {
3    "templateName": "ContractExtractionTemplate",
4    "contextDefinitionDeveloperName": "ContractExtractionContextDefinition",
5    "mappingName": "ContractExtractionMappingName",
6    "targetObject": "Contract",
7    "recordType": "CLM",
8    "additionalUseCaseInput": "{\"ModelName\":\"OpenAI\"}"
9  },
10  "contextAttributeMapping": [
11    {
12      "attributeId": "11nxx000001hOozAAE",
13      "description": "extract startDate from the document"
14    },
15    {
16      "attributeId": "11nxx000001hOozAAV",
17      "description": "extract startDate from the document"
18    },
19    {
20      "attributeId": "11nxx000001hOozAAR",
21      "description": "extract startDate from the document"
22    }
23  ]
24}

Properties

Name	Type	Description	Required or Optional	Available Version
`contextAttributeMapping`	Extraction Context Attribute Mapping Input[]	List of attributes and their mappings.	Yes	61.0
`contextUseCaseMapping`	Extraction Context Use Case Mapping Input	Details of the use case for which the mapping is defined.	Yes	61.0

Response Body for PATCH

Extraction Context Mappings