Set Mapping

PUT 
/mappings/:mappingId

Sets an mapping; available as an Add-On Module

Request

Path Parameters

mappingId stringrequired

Mapping Identifier

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 [

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

]

Responses

200

200 CREATED

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

message string

Result message

Example (from schema)

{
  "message": "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...