1. Overview

These services create a preview ticket that contains session settings such as the catalog version, user data, or language data.

1.1. Version information

Version : 1.0

1.2. License information

License : Use of this file is subject to the terms of your agreement with SAP SE or its affiliates respecting the use of the SAP product for which this file relates.
Terms of service : null

1.3. URI scheme

Host : localhost:9001
BasePath : /previewwebservices

1.4. Tags

  • Preview : Operation for preview ticket

1.5. Produces

  • application/xml

  • application/json

2. Paths

2.1. Creates a new preview ticket.

POST /v1/preview

2.1.1. Parameters

Type Name Description Schema

Body

previewTicketInformation
required

Preview ticket to be created

previewTicket

2.1.2. 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

404

Not Found

No Content

2.1.3. Consumes

  • application/xml

  • application/json

2.1.4. Tags

  • Preview

2.1.5. Security

Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

2.2. Returns a preview ticket DTO.

GET /v1/preview/{ticketId}

2.2.1. Parameters

Type Name Description Schema

Path

ticketId
required

Preview ticket identifier

string

2.2.2. 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

2.2.3. Tags

  • Preview

2.2.4. Security

Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

2.3. Updates an existing preview ticket.

PUT /v1/preview/{ticketId}

2.3.1. Parameters

Type Name Description Schema

Path

ticketId
required

Preview ticket identifier

string

Body

previewTicketInformation
required

Details of the ticket to be updated

previewTicket

2.3.2. Responses

HTTP Code Description Schema

200

OK

previewTicket

201

Created

No Content

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

2.3.3. Consumes

  • application/xml

  • application/json

2.3.4. Tags

  • Preview

2.3.5. Security

Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3. Definitions

3.1. catalogVersion

Name Description Schema

catalog
required

Catalog ID

string

catalogVersion
required

Catalog version

string

3.2. previewTicket

Preview Ticket.

Name Description Schema

catalogVersions
optional

Catalog version list

< catalogVersion > array

evaluateRestrictions
optional

Set to true to evaluate the restrictions against all matching pages.

boolean

language
optional

Language of the preview ticket

string

pageId
optional

CMS page ID to use for the preview

string

resourcePath
required

Resource path.

string

siteId
optional

UID of the site

string

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

versionId
optional

CMS version ID to use for the preview

string

4. Security

4.1. oauth2_Password

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

Name

basic

4.2. oauth2_client_credentials

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

Name

extended