Menu

Lumen help

Content manipulation / QSHMode

This section covers how to set up the Query String Handling mode (QSHMode).

By default, resources are cached using their complete URL, including the query string. Because elements of the query string can be unique for each user, the result can be frequent cache misses. QSHMode allows the removal of the query string or portions of the query string from the cache key.

Currently, the API only allows suppressing the full query string, by setting the type attribute to the value "string". The action attribute determines if the query string is included in the cache key ("honor") or ignored ("ignore").

Description

Creates a new content manipulation group. Supports a QSHMode object, which includes a type identifier (only "string" supported) and the action attribute ("honor" or "ignore").

Method

POST

Base URI

https://ws.lumen.com

Body syntax

{
"ContentManipulation": {
"qshmode": {
"type": "string", # required
"action": ("honor" | "ignore" ) # required
}
}
}

URI syntax

/serviceConfiguration/(version)/(scope)/ResourceGroups/(rgid)/ConfGroups/ContentManipulation

version [CDATA[ ]] Values: "v1.0" (required)
scope [CDATA[ ]] (AG)/(SCID)[/(ALIAS)]

AG = Access Group

SCID = Service Component Identifier

ALIAS = Optional Alias identifies Property

Example

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net/ResourceGroups/videos/ConfGroups/ContentManipulation

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups/videos/ConfGroups/ContentManipulation

{
"ContentManipulation": {
"qshmode": {
"action": "ignore",
"type": "string"
}
}
}

{
"ContentManipulation": {
"qshmode": {
"action": "ignore",
"type": "string"
}
}
}

Possible status and error messages returned to client

201: Created

Additional return codes and error messages

Description

Retrieves the content manipulation configuration group with the QSHMode settings of a given resource group for service component or property.

Method

GET

Base URI

https://ws.lumen.com

URI syntax

/serviceConfiguration/(version)/(scope)/ResourceGroups/(rgid)/ConfGroups/ContentManipulation

version [CDATA[ ]] Values: "v1.0" (required)
scope [CDATA[ ]] (AG)/(SCID)[/(ALIAS)]

AG = Access Group

SCID = Service Component Identifier

ALIAS = Optional Alias identifies Property

Example

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net/ResourceGroups/videos/ConfGroups/ContentManipulation

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups/videos/ConfGroups/ContentManipulation

{
"ContentManipulation": {
"qshmode": {
"action": "ignore",
"type": "string"
}
}
}

Possible status and error messages returned to client

200: Request Successful.

Additional return codes and error messages

Description

Updates a content manipulation group. Supports a QSHMode object, which includes a type identifier (only "string" supported) and the action attribute ("honor" or "ignore").

Method

PUT

Base URI

https://ws.lumen.com

Body syntax

{
"ContentManipulation": {
"qshmode": {
"type": "string", # required
"action": ("honor" | "ignore" ) # required
}
}
}

URI syntax

/serviceConfiguration/(version)/(scope)/ResourceGroups/(rgid)/ConfGroups/ContentManipulation

version [CDATA[ ]] Values: "v1.0" (required)
scope [CDATA[ ]] (AG)/(SCID)[/(ALIAS)]

AG = Access Group

SCID = Service Component Identifier

ALIAS = Optional Alias identifies Property

Example

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/test1.caching.cdn.lumen.net/ResourceGroups/videos/ConfGroups/ContentManipulation

https://ws.lumen.com/serviceConfiguration/v1.0/1234/BBBN5678/ResourceGroups/videos/ConfGroups/ContentManipulation

{
"ContentManipulation": {
"qshmode": {
"action": "honor",
"type": "string"
}
}
}

[Empty]

Possible status and error messages returned to client

204: Success no Content.

Additional return codes and error messages