MTPS Service Api Documentation Index

All endpoints support GET, HEAD, and OPTIONS requests unless otherwise specified.

GET: responds with a representation of the resource identified by the specified Url in the entity body. By default the resource is represented by a microformatted Xhtml document.
HEAD: responds with the HTTP headers describing the resource located at the specified Url without responding with an entity body.
OPTIONS: responds with a comma delimited list of the Http methods supported by the endpoint at the specified Url. This list is supplied in both the Allow: header and in the entity body of the response.

~/ - Service root
/content - Content Publishing (new topic)
Supported Http Methods: POST, OPTIONS
~/content/{shortid} - Content item version/locale listing (canonical URL form)
~/content/{shortid}/{locale};{version} - Content item (canonical URL form)
~/content/{shortid}/{locale};{version}/primary/{format} - Content item primary document
~/content/{shortid}/l={locale};v={version} - Content item (noncanonical)
~/content/{shortid}/{version};{locale} - Content item (noncanonical)
~/content/{alias} - content item version/locale listing (noncanonical)
~/content/{shortid}/{locale};{version}/paths - List of paths to navigation roots (pageable)
~/content/{shortid}/{locale};{version}/paths/{pathid} - Description of path to specified content item with path ID {pathid}
~/content/{shortid}/{locale};{version}/raw - The specified content item in raw XML format.
~/docs - The documentation you're reading now
~/content/image/{dynamicName} - Image addresed by its Dynamic Name.
~/content/validator - Validation tooling for checking MTPS ContentItem topics against the Xml schemas (and other business logic) which are used to validate them when publishing into the system.
Supported Http Methods: POST, OPTIONS
~/packages[?deploymentCritera] - List of Packages known to the system (pageable). MAY be filtered by specifying ONE of the deployment criterea described below in which case only packages meeting the specified critera will be listed.
- deployed=true|false
- readyToDeploy=true|false
- deployedSince={RFC 1123 Date}
- dirtySince={RFC 1123 Date}
~/packages/{package} - List of constituent resources making up the package
~/products - List of Product Groups known to the system
~/products/{productGroup} - List of products for the specific Product Group
~/products/{productGroup}/{product} - List of books associated with the specific productGroup/product combination
~/products/{productGroup}/{product}/{book}[?deploymentCritera] - List of Packages comprising the specified book. MAY be filtered by specifying ONE of the deployment criterea described below in which case only packages meeting the specified critera will be listed.
- deployed=true|false
- readyToDeploy=true|false
- deployedSince={RFC 1123 Date}
- dirtySince={RFC 1123 Date}
~/schemas - Directory Listing of Xml Schema, DTD, and vocabulary files which formally describe the various components of an MTPS ContentItem (Topic).

MTPS Service Api Documentation

Commonly Supported Http Methods

Endpoint Url Specifications