Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Document Properties Marker
doctypeapp-web-resource
overridefalse

Short DescriptionProvide access to userscript files for a given context. Even anonymous users have access to this service.
NameUserscripts Context Service
Short Name
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
property-restrict-value-rangetrue
propertyCategories

Tags
Tag List
propertyTags

Flagshide
Iteration

Iteration
filled
valuereleased

hide
Path

Parent Property
append-text/context
parent-doctypeapp-web-resource
add-linkfalse
propertyPath
property-namePath
appendtrue
default-not-set/context


HTTP Method

Name List
doctypeapp-parameter
render-no-hits-as-blanktrue
namesGET
property-restrict-value-rangetrue
propertyHTTP Method
where$<Type>=[HTTP Method]


Type

Name List
doctypeapp-web-resource-type
render-no-hits-as-blanktrue
namesResource Service
property-restrict-value-rangetrue
propertyType


Suite

Name List
doctypeapp, app-extension, product-space
property-restrict-value-rangetrue
defaults-toancestor
propertySuite

hide
App-Tool
Name List
doctypeapp-tool
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyApp-Tool

Since1.0
Deprecated
Removed
Defined Path Parameters

Name List
doctypeapp-parameter
render-no-hits-as-blanktrue
property

-restrict-value-range
property

false
Defined Path Parameters
where$<Type>=[HTTP Parameter]

hideDefined Query Parameters

Name List
doctypeapp-parameter
render-no-hits-as-blanktrue

property-restrict-value-rangefalse

namesPage Identifier
propertyDefined Query Parameters
where$<Type>=[HTTP Parameter]

hideInput Representation Types

Name List
doctype

property

app-datatype
render-no-hits-as-blanktrue
property-restrict

-one

-value

falseproperty

-

restrict-value-

rangetrue
propertyInput Representation Types


Output Representation Types

Name List
doctype

property

app-datatype
render-no-hits-as-blanktrue
property-restrict-

one-

value

falseproperty

-

restrict-value-

rangetrue
propertyOutput Representation Types


Defined Return Codes

Name List
doctypeapp-

parameter

code
render-no-hits-as-blanktrue

property-restrict-one-valuefalse

names200 - OK, 404 - Not Found, 500 - Internal Error
property-restrict-value-rangetrue
propertyprojectdoc.doctype.app-common.returnCodes
where$<Type>=[HTTP Response Code]

hideSort Keyhide
Section
show-titlefalse
titleDescription

When Userscripts for Confluence is installed, then this service is automatically called on each access of a user to a resource on Confluence. It checks whether the current contexts activates a script by matching the activation record

Static Document Link
documentUserscript (Glossary)
to-lower-casetrue
by matching the
Static Document Link
documentActivation Record
to-lower-casetrue
.

The activation record contains the following properties.

Display Table
doctypeapp-parameter
render-no-hits-as-blanktrue
render-modedefinition
selectShort Name+, Short Description, Since|
where$<Flags>=[activation-record]
header-translationsShort Name=Name

...

Section
titleQuery Parameters
intro-textThe web resource defines the following query parameters.
Section Compiler by Reference
refDefined Query Parameters
render-classesquery-parameters-sections, section-compiler-by-reference, query-parameters
ids-Description, Details
extract-short-desctrue


Section
show-titlefalsetitleInput

Section
show-titlefalsetitleResult

Section
titleReturn Codes
intro-textThe web resource defines the following parameters.
Section Compiler by Reference
refDefined Return Codes
render-classesreturn-codes-sections, section-compiler-by-reference, return-codes
ids-Description, Details
extract-short-desctrue


false
Section
show-title
titleDetails

false
Section
show-title
titleExamples

Section
titleRelated Web Resources
Display Table
doctypedoctype
render-no-hits-as-blanktrue
selectName, Short Description
render-classesrelated-entities-table, display-table, related-entities
where$<Tags>~(${Tags})

...