2022 June Release

Struct FSCOWS@1.1001:FriendlyURLConfigType Permanent link for this heading

REST API Configuration

The type (friendlyurltype) determines how parameters of the
REST call are mapped to the implementation (friendlyurlaction).

Type FSCOWS@1.1001:OpenAPI
  • friendlyurlurl
    Contains the distinctive static URL prefix.
    E.g. documentapi
    Define the URL key documentapi to match http://localhost/fsc/documentapi.
    Must not contain any slash.
  • friendlyurlargs
    Contains static URL parts, named URL parameters and named query parameters following friendlyurlurl.

    E.g. /{arg1}?{urlarg1}
    Match URL http://localhost/fsc/documentapi/123?urlarg1=true
    Define the URL parameter arg1 and the query parameter urlarg1.

    E.g. /v2/{arg1}/{arg2}?{urlarg1}{urlarg2}
    Match URL http://localhost/fsc/documentapi/v2/123/456?urlarg1=true&urlarg2=FK007
    Define the URL parameters arg1 and arg2 and the query parameters urlarg1 and urlarg2.

    Match URLs
    Request URLs are matched using
    1. friendlyurlurl
    2. friendlyurlallowedmethods
    3. friendlyurlargs static URL parts
    If multiple static prefixes match, the entry with the most matching static url parts is used.
  • friendlyurlallowedmethods
    The request method has to match the specified methods.
  • friendlyurlaction
    The arguments for the action are matched by name.
  • friendlyurloutcont
    If set, the value of this parameter is used as response content.
  • Input Parameters
    Input parameters are resolved by name from:
    1. Named URL parameters
    2. Named query parameters
    3. Request content
      JSON (Content-Type: "application/json; charset=utf-8")
      The document is parsed and named parameters are resolved by name based on parameter types.
      • Basic JSON Types
        The value is matched according to JSON2Value.
      • DATETIME
        The value is matched according to xs:DateTime eg. "2001-10-26T21:32:52".
      • NamedPart
        The string value has to match the filename of an attached document.
      • Other aggregate type
        The value is expected to be structured. Every structure member is resolved as described.
      • Values must match the corresponding type, enumeration values are matched by reference.
    Output Parameters
    Output parameters are added by name and to a result JSON document "Content-Type" "application/json; charset=utf-8".
    The transformation of values is implemented according to the resolving of input parameters.

Type FSCOWS@1.1001:FriendlyURL (default)
Description of input and output parameters using

Additional Information

Properties Permanent link for this heading

Type

Property

Name

Action

friendlyurlaction

DAV Action

HTTPMethods[]

friendlyurlallowedmethods

Allowed HTTP Methods

string

friendlyurlargs

URL Arguments

boolean

friendlyurldefaultcsp

HTTP Response Requires Script Execution

string

friendlyurlincont

Content Input Parameter

boolean

friendlyurlisreadonly

Action Will not Change State

string

friendlyurloutcont

Content Output Parameter

FriendlyURLParameterType[]

friendlyurlparams

Parameter Mapping

SoftwareComponent

friendlyurlswc

Software Component

FriendlyURLType

friendlyurltype

Type

string

friendlyurlurl

URL Marker

Properties Permanent link for this heading


DAV Action (FSCOWS@1.1001:friendlyurlaction) Permanent link for this heading

Defines the action that is called when the friendly URL is invoked.

Action FSCOWS@1.1001:friendlyurlaction not null

Additional Information


Allowed HTTP Methods (FSCOWS@1.1001:friendlyurlallowedmethods) Permanent link for this heading

Defines the list of allowed HTTP request methods.

unique HTTPMethods[] FSCOWS@1.1001:friendlyurlallowedmethods

Additional Information


URL Arguments (FSCOWS@1.1001:friendlyurlargs) Permanent link for this heading

Schema FSCOWS@1.1001:OpenAPI. The pattern to match named URL parameters and named query parameters following friendlyurlurl.

string FSCOWS@1.1001:friendlyurlargs

Additional Information


HTTP Response Requires Script Execution (FSCOWS@1.1001:friendlyurldefaultcsp) Permanent link for this heading

By help of the content security policy (CSP) settings (see property cspdirectives of DefaultConfiguration) CSP directives may be applied for friendly URL requests (e.g. you may configure that the execution of scripts should be disabled when executing requests for friendly URLs). You may set this option to true if the CSP directives of ordinary http requests should be used for requests for this friendly URL, too.
For a detailed description to content security policy refer to: http://www.w3.org/TR/CSP2/

boolean FSCOWS@1.1001:friendlyurldefaultcsp

Additional Information


Content Input Parameter (FSCOWS@1.1001:friendlyurlincont) Permanent link for this heading

In the parameter with this name, the incoming HTTP request's body is passed to the friendly URL action. The parameter can be of type CONTENT or STRING.

string FSCOWS@1.1001:friendlyurlincont

Additional Information


Action Will not Change State (FSCOWS@1.1001:friendlyurlisreadonly) Permanent link for this heading

The friendly URL action will not change any state. In that case the cross site request forgery check is turned off for this kind of URLs (see csrf and csrffurlwhitelist for more details).
CSRF attacks specifically target state-changing requests and not theft of data, since the attacker has no way to see the response to the forged request.
Therefore, if the friendly URL action (friendlyurlaction) or actions called by the friendly URL action will change any state this property must not be set to true.

boolean FSCOWS@1.1001:friendlyurlisreadonly

Additional Information


Content Output Parameter (FSCOWS@1.1001:friendlyurloutcont) Permanent link for this heading

Defines the name of the friendly URL action's parameter that is used to determine the outgoing HTTP response body. The parameter can be of type CONTENT, Content or STRING.

string FSCOWS@1.1001:friendlyurloutcont

Additional Information


Parameter Mapping (FSCOWS@1.1001:friendlyurlparams) Permanent link for this heading

Parameters passed from the invoked friendly URL are mapped to the friendly URL's action using this parameter mapping.

unique FriendlyURLParameterType[] FSCOWS@1.1001:friendlyurlparams

Additional Information


Software Component (FSCOWS@1.1001:friendlyurlswc) Permanent link for this heading

Software component.

SoftwareComponent FSCOWS@1.1001:friendlyurlswc

Additional Information


Type (FSCOWS@1.1001:friendlyurltype) Permanent link for this heading

The schema defines how to map parameters of the REST API.

FriendlyURLType FSCOWS@1.1001:friendlyurltype

Additional Information


URL Marker (FSCOWS@1.1001:friendlyurlurl) Permanent link for this heading

Defines the URL marker for a specific friendly URL. Example: "myfurl" for https://localhost/fsc/myfurl.

string FSCOWS@1.1001:friendlyurlurl not null

Additional Information