Jump to

• Request
• Response

listCmsContentMaps

get

/ccadmin/v1/cmsContentMaps

List CmsContentMaps. Returns a list of CmsContentMaps.

Request

Supported Media Types

• application/json

Query Parameters

• type(optional): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listCmsContentMaps_response

Type: object

Show Source

• items(optional): array items
  The list of CMSContentMap objects.

{
    "properties":{
        "items":{
            "description":"The list of CMSContentMap objects.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "createdDate":{
                        "description":"The date the record was created.",
                        "type":"string"
                    },
                    "cmsSubDirectory":{
                        "description":"The sub directory.",
                        "type":"string"
                    },
                    "sourceType":{
                        "description":"The source type.",
                        "type":"string"
                    },
                    "contentId":{
                        "description":"The content ID.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The repository ID.",
                        "type":"string"
                    },
                    "cmsPageSlug":{
                        "description":"The page slug.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The ID.",
                        "type":"string"
                    },
                    "contentType":{
                        "description":"The content type.",
                        "type":"string"
                    },
                    "layoutId":{
                        "description":"The layout ID.",
                        "type":"string"
                    },
                    "channelId":{
                        "description":"The channel ID.",
                        "type":"string"
                    },
                    "localeId":{
                        "description":"The locale ID.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of CMSContentMap objects.

Show Source

• Array of: object items

{
    "description":"The list of CMSContentMap objects.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "createdDate":{
                "description":"The date the record was created.",
                "type":"string"
            },
            "cmsSubDirectory":{
                "description":"The sub directory.",
                "type":"string"
            },
            "sourceType":{
                "description":"The source type.",
                "type":"string"
            },
            "contentId":{
                "description":"The content ID.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The repository ID.",
                "type":"string"
            },
            "cmsPageSlug":{
                "description":"The page slug.",
                "type":"string"
            },
            "id":{
                "description":"The ID.",
                "type":"string"
            },
            "contentType":{
                "description":"The content type.",
                "type":"string"
            },
            "layoutId":{
                "description":"The layout ID.",
                "type":"string"
            },
            "channelId":{
                "description":"The channel ID.",
                "type":"string"
            },
            "localeId":{
                "description":"The locale ID.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• channelId(optional): string
  The channel ID.
• cmsPageSlug(optional): string
  The page slug.
• cmsSubDirectory(optional): string
  The sub directory.
• contentId(optional): string
  The content ID.
• contentType(optional): string
  The content type.
• createdDate(optional): string
  The date the record was created.
• id(optional): string
  The ID.
• layoutId(optional): string
  The layout ID.
• localeId(optional): string
  The locale ID.
• repositoryId(optional): string
  The repository ID.
• sourceType(optional): string
  The source type.

{
    "type":"object",
    "properties":{
        "createdDate":{
            "description":"The date the record was created.",
            "type":"string"
        },
        "cmsSubDirectory":{
            "description":"The sub directory.",
            "type":"string"
        },
        "sourceType":{
            "description":"The source type.",
            "type":"string"
        },
        "contentId":{
            "description":"The content ID.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository ID.",
            "type":"string"
        },
        "cmsPageSlug":{
            "description":"The page slug.",
            "type":"string"
        },
        "id":{
            "description":"The ID.",
            "type":"string"
        },
        "contentType":{
            "description":"The content type.",
            "type":"string"
        },
        "layoutId":{
            "description":"The layout ID.",
            "type":"string"
        },
        "channelId":{
            "description":"The channel ID.",
            "type":"string"
        },
        "localeId":{
            "description":"The locale ID.",
            "type":"string"
        }
    }
}

Example Response (application/json)

[
    [
        {
            "createdDate":"2108-01-01T05:36:20.131Z",
            "cmsSubDirectory":"",
            "sourceType":"myBlog",
            "contentId":"123",
            "repositoryId":"100001",
            "cmsPageSlug":"blog/blog-1",
            "id":"1",
            "contentType":"default",
            "layoutId":"",
            "channelId":"1",
            "localeId":"1"
        },
        {
            "createdDate":"2108-01-01T05:36:20.131Z",
            "cmsSubDirectory":"",
            "sourceType":"myBlog",
            "contentId":"345",
            "repositoryId":"100002",
            "cmsPageSlug":"blog/blog-2",
            "id":"2",
            "contentType":"default",
            "layoutId":"blogLayout",
            "channelId":"1",
            "localeId":"1"
        }
    ]
]

Default Response

The 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