applications

A page control for an application

Returns the requested page control

get/applications/{app_id}/pagecontrols/{id}

Request

Base URL
https://api.webscale.com/v2
Auth
none declared
TypeScript
https://skmtc.dev/webscale/apis/webscale-apis/docs/applications/:app_id/pagecontrols/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

app_idstring required

Application id

idstring required

Page control id

Query parameters

attributesstring

A comma-separated list of attributes to be returned for the page control. Using a prefix of + or - respectively, will add or remove an attribute from the default set

Response

Success

namestring required

Short name describing the page control.

descriptionstring

Optional additional description of the page control.

mode'maintenance' | 'request' | 'response'

Set as 'maintenance' for maintenance mode page control.

enabledboolean

Enables or disables the page control.

hrefstring

A reference to this page control

versioninteger

The version of the page control. Versions are numbered, beginning with 1 and increase every time the page control is changed

createdstring

An iso8601 formatted timestamp

deletedstring

An iso8601 formatted timestamp

historyPageControl[] circular

Changes

No recorded changes to this operation across all 1 revision of this API.