Jump to

• Request
• Response

createCmsContentMap

post

/ccadmin/v1/cmsContentMaps

Create CmsContentMap. Creates a CmsContentMap object.

Request

Supported Media Types

• application/json

Body ()

Root Schema : createCmsContentMap_request

Type: object

Show Source

• channelId: string
  The channel ID.

  Example: A12345678
• cmsPageSlug: string
  The CMS url page slug.

  Example: /cars/all_new_rush
• contentId: string
  The content ID.

  Example: cars-all-new-rush
• contentType: string
  The content type.

  Example: default
• layoutId: string
  The layout ID.

  Example: pl200002
• sourceType: string
  The source type.

  Example: ExampleContent
• version: integer(long integer)
  The version of the content map.

  Example: 1

{
    "properties":{
        "sourceType":{
            "description":"The source type.",
            "type":"string",
            "example":"ExampleContent"
        },
        "contentId":{
            "description":"The content ID.",
            "type":"string",
            "example":"cars-all-new-rush"
        },
        "cmsPageSlug":{
            "description":"The CMS url page slug.",
            "type":"string",
            "example":"/cars/all_new_rush"
        },
        "layoutId":{
            "description":"The layout ID.",
            "type":"string",
            "example":"pl200002"
        },
        "version":{
            "format":"long integer",
            "description":"The version of the content map.",
            "type":"integer",
            "example":1
        },
        "contentType":{
            "description":"The content type.",
            "type":"string",
            "example":"default"
        },
        "channelId":{
            "description":"The channel ID.",
            "type":"string",
            "example":"A12345678"
        }
    },
    "required":[
        "cmsPageSlug",
        "layoutId",
        "contentId",
        "version",
        "contentType",
        "channelId",
        "sourceType"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createCmsContentMap_response

Type: object

Show Source

• channelId(optional): string
  The channel ID.

  Example: A12345678
• cmsPageSlug(optional): string
  The CMS url page slug.

  Example: /cars/all_new_rush
• contentId(optional): string
  The content ID.

  Example: cars-all-new-rush
• contentType(optional): string
  The content type.

  Example: default
• layoutId(optional): string
  The layout ID.

  Example: pl200002
• sourceType(optional): string
  The source type.

  Example: ExampleContent
• version(optional): integer(long integer)
  The version of the content map.

  Example: 1

{
    "properties":{
        "sourceType":{
            "description":"The source type.",
            "type":"string",
            "example":"ExampleContent"
        },
        "contentId":{
            "description":"The content ID.",
            "type":"string",
            "example":"cars-all-new-rush"
        },
        "cmsPageSlug":{
            "description":"The CMS url page slug.",
            "type":"string",
            "example":"/cars/all_new_rush"
        },
        "layoutId":{
            "description":"The layout ID.",
            "type":"string",
            "example":"pl200002"
        },
        "version":{
            "format":"long integer",
            "description":"The version of the content map.",
            "type":"integer",
            "example":1
        },
        "contentType":{
            "description":"The content type.",
            "type":"string",
            "example":"default"
        },
        "channelId":{
            "description":"The channel ID.",
            "type":"string",
            "example":"A12345678"
        }
    }
}

400 Response

When request is not input correctly or properties are missing. Specific missing properties will be highlighted.

Body ()

Root Schema : errorModel400

Type: object

Show Source

• errorCode(optional): string
  The CMS error code

  Example: 80205
• message(optional): string
  The HTTP error message

  Example: Required properties are missing or invalid
• status(optional): string
  The HTTP status code

  Example: 400

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The CMS error code",
            "type":"string",
            "example":80205
        },
        "message":{
            "description":"The HTTP error message",
            "type":"string",
            "example":"Required properties are missing or invalid"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string",
            "example":400
        }
    }
}

Default Response

The default error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top