Add New Mapping

POST 
/mappings

Creates a new mapping; available as an Add-On Module

Request

Query Parameters

siteId string

Site Identifier

application/json

Body

required

mapping

object

name string

Name of Mapping

description string

Description of Mapping

attributes

object[]

List of attributes

Array [

oneOf

MappingAttributeContent

Mapping Attribute from document content or content key-value data

attributeKey stringrequired

Attribute Key

sourceType MappingAttributeSourceType (string)required

Attribute Source Type

Possible values: [CONTENT, CONTENT_KEY_VALUE, METADATA, MANUAL, DATA_CLASSIFICATION, METADATA_EXTRACTION_RESULT, AI_PROMPT_RESULT, MALWARE_SCAN]

defaultValue string

Default value used when no matching value is found

defaultValues string[]

Default values used when no matching value is found

labelTexts string[]required

Label Texts

labelMatchingType MappingAttributeLabelMatchingType (string)required

Attribute Label Matching Type

Possible values: [FUZZY, EXACT, BEGINS_WITH, CONTAINS]

validationRegex string

Attribute Value Regex Validation

MappingAttributeMetadata

Mapping Attribute from document metadata

attributeKey stringrequired

Attribute Key

sourceType MappingAttributeSourceType (string)required

Attribute Source Type

Possible values: [CONTENT, CONTENT_KEY_VALUE, METADATA, MANUAL, DATA_CLASSIFICATION, METADATA_EXTRACTION_RESULT, AI_PROMPT_RESULT, MALWARE_SCAN]

defaultValue string

Default value used when no matching value is found

defaultValues string[]

Default values used when no matching value is found

labelTexts string[]required

Label Texts

labelMatchingType MappingAttributeLabelMatchingType (string)required

Attribute Label Matching Type

Possible values: [FUZZY, EXACT, BEGINS_WITH, CONTAINS]

metadataField MappingAttributeMetadataField (string)required

Attribute Metadata Field

Possible values: [USERNAME, PATH, CONTENT_TYPE]

MappingAttributeManual

Mapping Attribute with manually configured default values

attributeKey stringrequired

Attribute Key

sourceType MappingAttributeSourceType (string)required

Attribute Source Type

Possible values: [CONTENT, CONTENT_KEY_VALUE, METADATA, MANUAL, DATA_CLASSIFICATION, METADATA_EXTRACTION_RESULT, AI_PROMPT_RESULT, MALWARE_SCAN]

defaultValue string

Default value

defaultValues string[]

Default values

MappingAttributeDataClassification

Mapping Attribute from document data classification results

attributeKey stringrequired

Attribute Key

sourceType MappingAttributeSourceType (string)required

Attribute Source Type

Possible values: [CONTENT, CONTENT_KEY_VALUE, METADATA, MANUAL, DATA_CLASSIFICATION, METADATA_EXTRACTION_RESULT, AI_PROMPT_RESULT, MALWARE_SCAN]

MappingAttributeMetadataExtractionResult

Mapping Attribute from document metadata extraction results

attributeKey stringrequired

Attribute Key

sourceType MappingAttributeSourceType (string)required

Attribute Source Type

Possible values: [CONTENT, CONTENT_KEY_VALUE, METADATA, MANUAL, DATA_CLASSIFICATION, METADATA_EXTRACTION_RESULT, AI_PROMPT_RESULT, MALWARE_SCAN]

llmPromptEntityName stringrequired

LLM prompt entity name

MappingAttributeAiPromptResult

Mapping Attribute from document AI Prompt result

attributeKey stringrequired

Attribute Key

sourceType MappingAttributeSourceType (string)required

Attribute Source Type

Possible values: [CONTENT, CONTENT_KEY_VALUE, METADATA, MANUAL, DATA_CLASSIFICATION, METADATA_EXTRACTION_RESULT, AI_PROMPT_RESULT, MALWARE_SCAN]

llmPromptEntityName stringrequired

LLM prompt entity name

MappingAttributeMalwareScan

Mapping Attribute from document malware scan results

attributeKey stringrequired

Attribute Key

sourceType MappingAttributeSourceType (string)required

Attribute Source Type

Possible values: [CONTENT, CONTENT_KEY_VALUE, METADATA, MANUAL, DATA_CLASSIFICATION, METADATA_EXTRACTION_RESULT, AI_PROMPT_RESULT, MALWARE_SCAN]

]

classifications

object[]

List of classifications

Array [

classificationId stringrequired

Classification Identifier

conditions

object[]

List of classification conditions

Array [

oneOf

MappingClassificationConditionContent

Mapping Classification Condition

sourceType MappingClassificationConditionSourceType (string)required

Classification Condition Source Type

Possible values: [CONTENT, DATA_CLASSIFICATION, METADATA_EXTRACTION_RESULT, AI_PROMPT_RESULT]

matchingType MappingClassificationConditionMatchingType (string)required

Classification Condition Result Matching Type

Possible values: [EXACT, BEGINS_WITH, CONTAINS]

text stringrequired

Text to match against the document content

MappingClassificationConditionDataClassification

Mapping Classification Condition

sourceType MappingClassificationConditionSourceType (string)required

Classification Condition Source Type

Possible values: [CONTENT, DATA_CLASSIFICATION, METADATA_EXTRACTION_RESULT, AI_PROMPT_RESULT]

resultKey stringrequired

Result key

resultValue stringrequired

Result value

matchingType MappingClassificationConditionMatchingType (string)required

Classification Condition Result Matching Type

Possible values: [EXACT, BEGINS_WITH, CONTAINS]

MappingClassificationConditionMetadataExtractionResult

Mapping Classification Condition

sourceType MappingClassificationConditionSourceType (string)required

Classification Condition Source Type

Possible values: [CONTENT, DATA_CLASSIFICATION, METADATA_EXTRACTION_RESULT, AI_PROMPT_RESULT]

llmPromptEntityName stringrequired

LLM prompt entity name

resultKey stringrequired

Result key

resultValue stringrequired

Result value

matchingType MappingClassificationConditionMatchingType (string)required

Classification Condition Result Matching Type

Possible values: [EXACT, BEGINS_WITH, CONTAINS]

MappingClassificationConditionAiPromptResult

Mapping Classification Condition

sourceType MappingClassificationConditionSourceType (string)required

Classification Condition Source Type

Possible values: [CONTENT, DATA_CLASSIFICATION, METADATA_EXTRACTION_RESULT, AI_PROMPT_RESULT]

llmPromptEntityName stringrequired

LLM prompt entity name

resultKey stringrequired

Result key

resultValue stringrequired

Result value

matchingType MappingClassificationConditionMatchingType (string)required

Classification Condition Result Matching Type

Possible values: [EXACT, BEGINS_WITH, CONTAINS]

]

]

Responses

201

201 CREATED

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

mappingId string

Mapping Identifier

Example (from schema)

{
  "mappingId": "string"
}

400

400 OK

application/json

Schema

Schema

errors

object[]

List of errors

Array [

key string

Error Key

error string

Error Message

]

Example (from schema)

{
  "errors": [
    {
      "key": "string",
      "error": "string"
    }
  ]
}

Loading...