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
valuereleased

hide
Path

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


User Roles

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAnonymous
property-restrict-value-rangetrue
propertyUser Role


HTTP Method

Name List
doctypeapp-parametercode
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
propertyDefined Path Parameters
where$<Type>=[HTTP Parameter]

hide
Defined Query Parameters

Name List
doctypeapp-parameter
render-no-hits-as-blanktrue
namesPage Identifier
propertyDefined Query Parameters
where$<Type>=[HTTP Parameter]

hide
Input Representation Types

Name List
doctypeapp-datatype
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyInput Representation Types


Output Representation Types

Name List
doctypeapp-datatype
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyOutput Representation Types


Defined Return Codes

Name List
doctypeapp-code
render-no-hits-as-blanktrue
names200 - OK, 404 - Not Found, 500 - Internal Error
property-restrict-value-rangetrue
propertyprojectdoc.doctype.app-common.returnCodes
where$<Type>=[HTTP Response Code]

hide
Sort 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 

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|
sort-by#BREADTH_FIRST
where$<Flags>=[activation-record]
header-translationsShort Name=Name

...

Section
titlePath Parameters
intro-textThe web resource service defines the following path parameters.


Section Compiler by Reference
refDefined Path Parameters
selectID, Data Type, Since
render-classespath-parameters-sections, section-compiler-by-reference, path-parameters
ids-Description, Details
extract-short-desctrue



...

Section
titleQuery Parameters
intro-textThe web resource service defines the following query parameters.


Section Compiler by Reference
refDefined Query Parameters
selectID, Data Type, Since
render-classesquery-parameters-sections, section-compiler-by-reference, query-parameters
ids-Description, Details
extract-short-desctrue



...

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




Section
titleDetails
Note that this service can be used by anyone.


Section
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})

...