1. Overview

Preview Web Services Documentation

1.1. Version information

Version : 1.0.0

1.2. URI scheme

Host : localhost:9001
BasePath : /previewwebservices

1.3. Tags

  • Preview : Operation for preview ticket

1.4. Produces

  • application/xml

  • application/json

2. Security

2.1. oauth2_password

Type : oauth2
Flow : password
Token URL : /authorizationserver/oauth/token

Name

previewwebservices

2.2. oauth2_client_credentials

Type : oauth2
Flow : application
Token URL : /authorizationserver/oauth/token

Name

previewwebservices

3. Resources

3.1. Preview

Operation for preview ticket

3.1.1. Creates a new preview ticket.

POST /v1/preview
Parameters
Type Name Description Schema

Body

previewTicketDTO
required

Preview ticket to be created

previewTicket
Responses
HTTP Code Description Schema

201

Created

previewTicket

400

Bad Request e.g. incorrect request body data, missing parameters

No Content

401

Unauthorized

No Content

403

Forbidden. Have no access to this method

No Content
Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

3.1.2. Returns a preview ticket DTO.

GET /v1/preview/{ticketId}
Parameters
Type Name Description Schema

Path

ticketId
required

Preview ticket identifier

string
Responses
HTTP Code Description Schema

200

OK

previewTicket

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden. Have no access to this method

No Content

404

Ticket with given id doesn’t exist

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

3.1.3. Updates an existing preview ticket.

PUT /v1/preview/{ticketId}
Parameters
Type Name Description Schema

Path

ticketId
required

Preview ticket identifier

string

Body

previewTicketDTO
required

Details of the ticket to be updated

previewTicket
Responses
HTTP Code Description Schema

200

OK

previewTicket

400

Bad Request e.g. incorrect request body data, missing parameters

No Content

401

Unauthorized

No Content

403

Forbidden. Have no access to this method

No Content

404

Ticket with given id doesn’t exist

No Content

409

Conflict - ticket code in request body and url do not match

No Content
Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

4. Definitions

4.1. CxVariationKey

Name Schema

catalog
optional

string

catalogVersion
optional

string

customizationCode
optional

string

variationCode
optional

string

4.2. catalogVersion

Name Description Schema

catalog
required

Catalog ID

string

catalogVersion
required

Catalog version

string

4.3. previewTicket

Preview Ticket.

Name Description Schema

catalogVersions
optional

Catalog version list

< catalogVersion > array

language
optional

Language of the preview ticket

string

pageId
optional

CMS page ID to use for the preview

string

resourcePath
required

Resource path.

string

segments
optional

< string > array

ticketId
optional

Preview ticket ID

string

time
optional

Time of the preview ticket

string(date-time)

user
optional

User of the preview ticket

string

userGroup
optional

User group of the preview ticket

string

variations
optional

< CxVariationKey > array

versionId
optional

CMS version ID to use for the preview

string