Get Mappings

GET 
/mappings

Returns a list of mappings; available as an Add-On Module

Request

Query Parameters

siteId string

Site Identifier

limit string
Limit Results
Default value: 10
next string

Next page of results token

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

mappings

object[]

Array [

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

]

]

next string

Next page of results token

Example (from schema)

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

Loading...