Get Mapping

GET 
/mappings/:mappingId

Get a mapping; available as an Add-On Module

Request

Path Parameters

mappingId stringrequired

Mapping Identifier

Query Parameters

siteId string

Site Identifier

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

mapping

object

mappingId string

Mapping Identifier

name string

Name of Mapping

description string

Description of Mapping

attributes

object[]

List of attributes

Array [

attributeKey string

Attribute Key

sourceType MappingAttributeSourceType (string)

Attribute Source Type

Possible values: [CONTENT, CONTENT_KEY_VALUE, METADATA, MANUAL]

defaultValue string

Default value

defaultValues string[]

Default values

labelTexts string[]

labelMatchingType MappingAttributeLabelMatchingType (string)

Attribute Label Matching Type

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

metadataField MappingAttributeMetadataField (string)

Attribute Metadata Field

Possible values: [USERNAME, PATH, CONTENT_TYPE]

validationRegex string

Attribute Value Regex Validation

]

Example (from schema)

{
  "mapping": {
    "mappingId": "string",
    "name": "string",
    "description": "string",
    "attributes": [
      {
        "attributeKey": "string",
        "sourceType": "CONTENT",
        "defaultValue": "string",
        "defaultValues": [
          "string"
        ],
        "labelTexts": [
          "string"
        ],
        "labelMatchingType": "FUZZY",
        "metadataField": "USERNAME",
        "validationRegex": "string"
      }
    ]
  }
}

Loading...