Documentation Center

Create or Update Sitemap

Creates a new sitemap or updates the current sitemap with specified pub or language sitemaps.

Request

URI: /v2/sitemap/{pub}/{lang}

HTTP Method: PUT

Header params:
  • Accept: [application/json] OR [application/xml]
  • Content-Type: [application/json] OR [application/xml]
PATH Parameter(s):
  • pub: Update the sitemap with the specified publication. If this parameter is not provided, regenerate a new sitemap with all existing publications and their language variants. Any publication configured as "hidden" will be ignored and not added to the sitemap, nor will any of its language variants be added, even if they are individually configured as "visible."
  • lang: Update the sitemap with the specified language variant of the specified publication. If this parameter is not provided, update the sitemap with all language variants within the specified publication. Any language variant configured as "hidden" will be ignored and not added to the sitemap.

Response

Success
  • XML: <result message="Sitemap: pub updated" messageKey="Sitemap: pub updated" status="SUCCESS" statusCode="0" />
  • JSON: {"statusCode":0,"messageKey":"Action = create_SiteMap","message":"Action = create_SiteMap","status":"SUCCESS","info":[]}
Failed
  • XML: <result message="UNDEFINED" messageKey="Sitemap: pub update failed" status="FAIL" statusCode="500" />
  • JSON: {"statusCode":0,"messageKey":"Sitemap: pub updated","message":"Sitemap: pub updated","status":"SUCCESS","info":[]}

Permissions

"Manage application"

Example

Request:

PUT http://example.corp:8080/LiveContent/v2/sitemap/pub/lang

Accept: applicaton/xml

Content-Type: applicaton/xml

Response:

<result message="Sitemap: pub updated" messageKey="Sitemap: pub updated" status="SUCCESS" statusCode="0" />