2022 June Release

Actions of FSCOWS@1.1001 Permanent link for this heading

Return Type

Signature

void

AddJSAPIError(
  ref JSAPIError[] errors,
  any error,
  optional string key)

void

AttrHiddenResourcesDestructor(
  AttributeDefinition attrdef,
  any value)

void

AttrObjIsCollectionGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrObjIsCollectionGetVersion(
  AttributeDefinition attrdef,
  integer versnr,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

content

CallSoapXml(
  string url,
  optional dictionary httpheaders,
  optional content[] soapheaders,
  any xmlin,
  out retval content xmlout,
  optional integer parentwindow,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer timeoutresolve,
  optional integer timeoutconnect,
  optional integer timeoutsend,
  optional integer timeoutreceive,
  optional boolean usevappproxysettings,
  optional ContentObject cacert)

void

CallSoapXmlEx(
  any wsdlconnector,
  optional any soapconnector,
  string operation,
  optional any inparams,
  ref optional any outparams)

void

CheckContentAllowed(
  optional Content content)

void

CheckServiceToken(
  string token,
  out object scope,
  out string comment,
  optional string ipaddress,
  optional string useragent,
  optional string urlpath)

void

CheckServiceTokenExpiration()

void

CheckWebServiceAccess()

void

CreateOAuthClient(
  optional integer unused1,
  optional integer unused2)

void

CreateSoapFault(
  string errortext,
  SoapTransport encoding,
  out dictionary responsehttpheaders,
  out content responsehttpbody,
  SoapVersion version)

ObjectClass

DetermineFolderClass(
  object parent,
  AttributeDefinition attrdef,
  optional boolean disablefilter,
  out retval ObjectClass objectclass,
  optional boolean isdragdropimport)

ObjectClass

DetermineObjectClass(
  object parent,
  AttributeDefinition attrdef,
  string extension,
  optional boolean disablefilter,
  out retval ObjectClass objectclass,
  optional boolean isdragdropimport)

void

DTSSessionClose(
  string access_token)

void

DTSSessionCreate(
  out string access_token,
  out integer access_tokenttl,
  optional datetime access_expiresat)

void

ExecuteOperation(
  string operation,
  dictionary inparams,
  ref dictionary outparams)

void

GenerateWsdl(
  object websvcdef,
  out content wsdlcont,
  optional boolean untypedarrays,
  optional string deflocation,
  optional boolean transacted)

void

GetDisabledExtensions(
  out string[] extensions,
  out boolean checkarchives)

void

GetMapping(
  object action,
  optional object objclass,
  out optional object mapping)

void

GetSchema(
  object action,
  optional object objclass,
  ref optional content schema,
  ref optional string schemans)

string

GetServiceToken(
  optional string comment,
  object scope,
  optional ServiceTokenExpiration expiration,
  out retval string token)

ServiceTokenExpiration

GetServiceTokenExpiration(
  out retval ServiceTokenExpiration expiration)

void

ImportConflict(
  content request,
  object parentobj,
  object viewattref,
  out object conflict)

void

ImportConflictFriendlyURL(
  content request,
  object parentobj,
  object viewattrdef)

void

ImportContentFriendlyURL(
  content request,
  out content response)

void

ImportShareFriendlyURL(
  content request,
  object parentobj,
  object viewattrdef,
  object share)

boolean

IsClientLevelTrustEnabled(
  out retval boolean enabled)

boolean

IsServiceTokenAccessEnabled(
  out retval boolean state,
  out optional boolean visible)

boolean

IsTrusted(
  out retval boolean trusted)

string

JWTAuthCreateToken(
  WebServiceDefinition scope,
  out retval string token)

WebServiceDefinition

JWTAuthValidateToken(
  string token,
  out retval WebServiceDefinition scope)

NamedPart

MIME2Value(
  content mime,
  optional string contenttype,
  out retval NamedPart value)

object

OAuth2CheckBaseUri(
  string oa2baseuri,
  out retval object errormsg)

content

OAuth2CreatePostBody(
  dictionary reqdict,
  out optional string reqbodytxt,
  out retval content reqbody)

string

OAuth2GenerateResultURIFromError(
  string error,
  string error_description,
  out retval string rediruri)

string

OAuth2GenerateResultURIFromTokenResult(
  OAuth2HttpResponse response,
  out retval string rediruri)

string

OAuth2GenerateState(
  out retval string state)

string

OAuth2PrepareAuthRedirURI(
  dictionary headers,
  dictionary urlparams,
  out retval string rediruri)

dictionary

OAuth2PrepareHeaders(
  string contenttype,
  optional string accesstoken,
  out retval dictionary reqhdrs)

void

OAuth2SendHTTPRequest(
  string amethod,
  string uri,
  dictionary reqhdrs,
  content reqbody,
  out dictionary respheaders,
  out content respbody)

void

OAuth2StoreInUserSettings(
  dictionary headers,
  dictionary urlparams,
  integer expiresin)

string

OAuthAuthorize(
  object client,
  object[] scope,
  out retval string code,
  out boolean trusted,
  ref optional string redirecturi,
  optional AuthMeth authmeth,
  optional string ipaddress)

void

OAuthCheckToken(
  string token,
  out object[] scope,
  out AuthMeth authmeth)

void

OAuthConfirm(
  object client,
  string code,
  optional boolean usesecclearance)

OAuthTokenExpiration

OAuthGetTokenExpiration(
  object client,
  out retval OAuthTokenExpiration expiration)

void

PostXML(
  string url,
  string object,
  string action,
  any xmlin,
  out content xmlout,
  optional integer parentwindow,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer timeoutresolve,
  optional integer timeoutconnect,
  optional integer timeoutsend,
  optional integer timeoutreceive,
  optional boolean ignorehttperrors,
  optional boolean usevappproxysettings,
  optional ContentObject cacert)

void

ProcessHttpSoapMessage(
  dictionary requesthttpheaders,
  content requesthttpbody,
  optional dictionary requestoptions,
  out integer actionresult,
  out dictionary responsehttpheaders,
  out content responsehttpbody,
  out boolean responseisfault)

void

RenewServiceToken(
  optional integer key)

void

SendHttpRequest(
  string verb,
  string url,
  optional dictionary reqheaders,
  optional content reqbody,
  out optional dictionary respheaders,
  out optional content respbody,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer timeoutresolve,
  optional integer timeoutconnect,
  optional integer timeoutsend,
  optional integer timeoutreceive,
  optional boolean ignorehttperrors,
  optional boolean usevappproxysettings,
  optional ContentObject cacert)

void

SendHttpRequestEx(
  string verb,
  string url,
  optional dictionary reqheaders,
  optional any reqbody,
  out optional dictionary respheaders,
  ref optional any respbody,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer timeoutresolve,
  optional integer timeoutconnect,
  optional integer timeoutsend,
  optional integer timeoutreceive,
  optional boolean ignorehttperrors,
  optional boolean usevappproxysettings,
  optional ContentObject cacert)

void

SendHttpSoapMessage(
  string url,
  SoapTransport coding,
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer resolvetimeout,
  optional integer connecttimeout,
  optional integer sendtimeout,
  optional integer receivetimeout,
  optional dictionary additionaloptions,
  optional boolean usevappproxysettings,
  optional boolean noparsefile,
  optional ContentObject cacert)

void

SendHttpTextRequest(
  string verb,
  string url,
  optional dictionary reqheaders,
  optional string reqbody,
  out optional dictionary respheaders,
  out optional string respbody,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer timeoutresolve,
  optional integer timeoutconnect,
  optional integer timeoutsend,
  optional integer timeoutreceive,
  optional boolean ignorehttperrors,
  optional boolean usevappproxysettings,
  optional ContentObject cacert)

void

ServiceTokenAccessPending(
  optional string ipaddress,
  optional string useragent,
  optional string urlpath)

void

ServiceTokenExpirationPending(
  ServiceTokenAccess[] tokenaccess)

void

ServiceTokenInvalid(
  optional ServiceTokenAccess tokenaccess,
  optional string ipaddress,
  optional string useragent,
  optional string urlpath)

void

SOAPAbort()

void

SOAPCommit()

void

SOAPCreateContentObjects(
  any xmlin,
  out content xmlout)

content

Value2MIME(
  NamedPart value,
  ref string contenttype,
  out retval content mime)

void

WebDAVFriendlyURL()

void

WebDAVObjectChangeClass(
  object oldclass,
  object newclass)

void

WebDAVObjectModified(
  ref object modifiedobj,
  object parentviewattr,
  string webdavmethod,
  integer contentsizebefore,
  integer contentsizeafter)

void

WOPIGetUserStatus(
  object document,
  ref WOPIUserStatus status)

void

WOPISessionClose(
  string access_token)

void

WOPISessionCreate(
  out string access_token,
  out integer access_tokenttl,
  optional datetime access_expiresat)

void

WOPIURLSrcGet(
  out string urlsrc,
  out string favicon,
  optional string wopiaction,
  optional string wopiextension,
  optional string wopiapplication,
  optional string wopinetzone)

void

WSJSONFriendlyURL(
  string definition,
  string operation,
  content request,
  out string response)

object[]

XeditorGetLockTargets(
  out retval object[] locktargets,
  Action operation)

void

XeditorRead(
  ref Content content,
  AttributeDefinition attrdef)

void

XeditorSessionClose(
  string access_token)

void

XeditorSessionCreate(
  out string access_token,
  out integer access_tokenttl,
  optional datetime access_expiresat)

string

XeditorURLSrcGet(
  out retval string urlsrc)

void

XeditorWrite(
  ref Content content,
  AttributeDefinition attrdef)


FSCOWS@1.1001:AddJSAPIError Permanent link for this heading

void FSCOWS@1.1001:AddJSAPIError(
  ref JSAPIError[] errors,
  any error,
  optional string key)

Name

Description

errors

error

key

Additional Information


FSCOWS@1.1001:AttrHiddenResourcesDestructor Permanent link for this heading

void FSCOWS@1.1001:AttrHiddenResourcesDestructor(
  AttributeDefinition attrdef,
  any value)

Name

Description

attrdef

value

Additional Information


FSCOWS@1.1001:AttrObjIsCollectionGet Permanent link for this heading

void FSCOWS@1.1001:AttrObjIsCollectionGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCOWS@1.1001:AttrObjIsCollectionGetVersion Permanent link for this heading

void FSCOWS@1.1001:AttrObjIsCollectionGetVersion(
  AttributeDefinition attrdef,
  integer versnr,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

versnr

value

volatile

volatiletx

Additional Information


FSCOWS@1.1001:CallSoapXml Permanent link for this heading

Call a SOAP action with XML parameters.

content FSCOWS@1.1001:CallSoapXml(
  string url,
  optional dictionary httpheaders,
  optional content[] soapheaders,
  any xmlin,
  out retval content xmlout,
  optional integer parentwindow,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer timeoutresolve,
  optional integer timeoutconnect,
  optional integer timeoutsend,
  optional integer timeoutreceive,
  optional boolean usevappproxysettings,
  optional ContentObject cacert)

Name

Description

url

The URL endpoint for the HTTP request.

httpheaders

A DICTIONARY which is used to specify the HTTP requests' headers as key value pairs. e.g. "X-MyHeader: MyValue".

soapheaders

xmlin

The XML content for the HTTP request. This has to be wellformed XML.

xmlout

The received XML content of the HTTP reponse.

parentwindow

Internal use.

user

The username used for basic authentication.

password

The password used for basic authentication.

proxyuser

The username used for basic authentication at the proxy server.

proxypassword

The password used for basic authentication at the proxy server.

clientcert

The client certificate object used for client certificate authentication.

timeoutresolve

Resolve timeout (in seconds) for the given URL.

timeoutconnect

Connection timeout (in seconds) for the given URL.

timeoutsend

Upload timeout (in seconds) for the HTTP request.

timeoutreceive

Download timeout (in seconds) for the HTTP response.

usevappproxysettings

Use the proxy settings defined in the current vApp Configuration (DefaultConfiguration). The vApp Configuration is only used if proxyuser is null or empty.

cacert

Content object containing a CA certificate bundle to validate the server (PEM format, complete CA chain to server certificate).

Additional Information


FSCOWS@1.1001:CallSoapXmlEx Permanent link for this heading

Send a simple SOAP message

void FSCOWS@1.1001:CallSoapXmlEx(
  any wsdlconnector,
  optional any soapconnector,
  string operation,
  optional any inparams,
  ref optional any outparams)

Name

Description

wsdlconnector

The HTTP connector object or HttpConnAggr used to specify the location of the web service's WSDL document.

soapconnector

The HTTP connector object or HttpConnAggr used to specify operation endpoint of the web service.

operation

The operation which is to be invoked at the web service.

inparams

The input parameters of the SOAP call. Parameters can be specified as DICTIONARY, CONTENT, Content, STRING or OBJECT. Parameters as a DICTIONARY are mapped to XML as key value pairs, whereas key is the node name and value is the node's value. Parameter values as CONTENT, Content or STRING are directly used as SOAP payload, therefore these contents have to be wellformed XML. For a parameter passed as OBJECT the object's XML representation is used as SOAP payload.

outparams

The output parameters of the SOAP call. The output parameter type is dependent on the type used for the inparams parameter.

Additional Information


FSCOWS@1.1001:CheckContentAllowed Permanent link for this heading

void FSCOWS@1.1001:CheckContentAllowed(
  optional Content content)

Name

Description

content

Additional Information


FSCOWS@1.1001:CheckServiceToken Permanent link for this heading

void FSCOWS@1.1001:CheckServiceToken(
  string token,
  out object scope,
  out string comment,
  optional string ipaddress,
  optional string useragent,
  optional string urlpath)

Name

Description

token

scope

comment

ipaddress

useragent

urlpath

Additional Information


FSCOWS@1.1001:CheckServiceTokenExpiration Permanent link for this heading

void FSCOWS@1.1001:CheckServiceTokenExpiration()

Additional Information


FSCOWS@1.1001:CheckWebServiceAccess Permanent link for this heading

void FSCOWS@1.1001:CheckWebServiceAccess()

Additional Information


FSCOWS@1.1001:CreateOAuthClient Permanent link for this heading

void FSCOWS@1.1001:CreateOAuthClient(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCOWS@1.1001:CreateSoapFault Permanent link for this heading

Internally used to create a SOAP fault message.

void FSCOWS@1.1001:CreateSoapFault(
  string errortext,
  SoapTransport encoding,
  out dictionary responsehttpheaders,
  out content responsehttpbody,
  SoapVersion version)

Name

Description

errortext

encoding

responsehttpheaders

responsehttpbody

version

Additional Information


FSCOWS@1.1001:DetermineFolderClass Permanent link for this heading

ObjectClass FSCOWS@1.1001:DetermineFolderClass(
  object parent,
  AttributeDefinition attrdef,
  optional boolean disablefilter,
  out retval ObjectClass objectclass,
  optional boolean isdragdropimport)

Name

Description

parent

attrdef

disablefilter

objectclass

isdragdropimport

Additional Information


FSCOWS@1.1001:DetermineObjectClass Permanent link for this heading

ObjectClass FSCOWS@1.1001:DetermineObjectClass(
  object parent,
  AttributeDefinition attrdef,
  string extension,
  optional boolean disablefilter,
  out retval ObjectClass objectclass,
  optional boolean isdragdropimport)

Name

Description

parent

attrdef

extension

disablefilter

objectclass

isdragdropimport

Additional Information


FSCOWS@1.1001:DTSSessionClose Permanent link for this heading

Close a DTS session: access_token is not usable thereafter.

void FSCOWS@1.1001:DTSSessionClose(
  string access_token)

Name

Description

access_token

the access_token

Additional Information


FSCOWS@1.1001:DTSSessionCreate Permanent link for this heading

Create a DTS session: access_token to be used with a url

void FSCOWS@1.1001:DTSSessionCreate(
  out string access_token,
  out integer access_tokenttl,
  optional datetime access_expiresat)

Name

Description

access_token

the access_token

access_tokenttl

the access_token ttl

access_expiresat

the maximum lifetime of the token, the default uses session defaults.

Additional Information


FSCOWS@1.1001:ExecuteOperation Permanent link for this heading

Execute open api operation

void FSCOWS@1.1001:ExecuteOperation(
  string operation,
  dictionary inparams,
  ref dictionary outparams)

Name

Description

operation

the operation to execute

inparams

dictionary with all input parameters

outparams

dictionary with all output parameters

Additional Information


FSCOWS@1.1001:GenerateWsdl Permanent link for this heading

Generates a WSDL document from an object of class WebServiceDefinition.

void FSCOWS@1.1001:GenerateWsdl(
  object websvcdef,
  out content wsdlcont,
  optional boolean untypedarrays,
  optional string deflocation,
  optional boolean transacted)

Name

Description

websvcdef

The object of class WebServiceDefinition.

wsdlcont

The resulting WSDL document.

untypedarrays

If this boolean parameter is TRUE then all array typed parameters of the SOAP actions will have no element type. This is useful for SOAP clients programs that have no typed arrays, like the VBScript language.

deflocation

Default endpoint of the web service.

transacted

Additional Information


FSCOWS@1.1001:GetDisabledExtensions Permanent link for this heading

void FSCOWS@1.1001:GetDisabledExtensions(
  out string[] extensions,
  out boolean checkarchives)

Name

Description

extensions

checkarchives

Additional Information


FSCOWS@1.1001:GetMapping Permanent link for this heading

Gets the actual mapping for a SOAP action.

void FSCOWS@1.1001:GetMapping(
  object action,
  optional object objclass,
  out optional object mapping)

Name

Description

action

objclass

mapping

Additional Information


FSCOWS@1.1001:GetSchema Permanent link for this heading

Gets the actual schema for a SOAP action.

void FSCOWS@1.1001:GetSchema(
  object action,
  optional object objclass,
  ref optional content schema,
  ref optional string schemans)

Name

Description

action

objclass

schema

schemans

Additional Information


FSCOWS@1.1001:GetServiceToken Permanent link for this heading

string FSCOWS@1.1001:GetServiceToken(
  optional string comment,
  object scope,
  optional ServiceTokenExpiration expiration,
  out retval string token)

Name

Description

comment

scope

expiration

token

Additional Information


FSCOWS@1.1001:GetServiceTokenExpiration Permanent link for this heading

ServiceTokenExpiration FSCOWS@1.1001:GetServiceTokenExpiration(
  out retval ServiceTokenExpiration expiration)

Name

Description

expiration

Additional Information


FSCOWS@1.1001:ImportConflict Permanent link for this heading

void FSCOWS@1.1001:ImportConflict(
  content request,
  object parentobj,
  object viewattref,
  out object conflict)

Name

Description

request

parentobj

viewattref

conflict

Additional Information


FSCOWS@1.1001:ImportConflictFriendlyURL Permanent link for this heading

void FSCOWS@1.1001:ImportConflictFriendlyURL(
  content request,
  object parentobj,
  object viewattrdef)

Name

Description

request

parentobj

viewattrdef

Additional Information


FSCOWS@1.1001:ImportContentFriendlyURL Permanent link for this heading

void FSCOWS@1.1001:ImportContentFriendlyURL(
  content request,
  out content response)

Name

Description

request

response

Additional Information


FSCOWS@1.1001:ImportShareFriendlyURL Permanent link for this heading

void FSCOWS@1.1001:ImportShareFriendlyURL(
  content request,
  object parentobj,
  object viewattrdef,
  object share)

Name

Description

request

parentobj

viewattrdef

share

Additional Information


FSCOWS@1.1001:IsClientLevelTrustEnabled Permanent link for this heading

boolean FSCOWS@1.1001:IsClientLevelTrustEnabled(
  out retval boolean enabled)

Name

Description

enabled

Additional Information


FSCOWS@1.1001:IsServiceTokenAccessEnabled Permanent link for this heading

boolean FSCOWS@1.1001:IsServiceTokenAccessEnabled(
  out retval boolean state,
  out optional boolean visible)

Name

Description

state

visible

Additional Information


FSCOWS@1.1001:IsTrusted Permanent link for this heading

boolean FSCOWS@1.1001:IsTrusted(
  out retval boolean trusted)

Name

Description

trusted

Additional Information


FSCOWS@1.1001:JWTAuthCreateToken Permanent link for this heading

Create a JWT token.

string FSCOWS@1.1001:JWTAuthCreateToken(
  WebServiceDefinition scope,
  out retval string token)

Name

Description

scope

The scope. The JWTAuth configuration is taken from the jwtauthconfig configuration.

token

Additional Information


FSCOWS@1.1001:JWTAuthValidateToken Permanent link for this heading

Validate a JWT token.

WebServiceDefinition FSCOWS@1.1001:JWTAuthValidateToken(
  string token,
  out retval WebServiceDefinition scope)

Name

Description

token

scope

The scope. The JWTAuth configuration is taken from the jwtauthconfig configuration.

Additional Information


FSCOWS@1.1001:MIME2Value Permanent link for this heading

Parse a MIME content and return value.

NamedPart FSCOWS@1.1001:MIME2Value(
  content mime,
  optional string contenttype,
  out retval NamedPart value)

Name

Description

mime

the mime content.

contenttype

the contenttype. If missing or invalid, the headers are parsed from mime.

value

the structured values.

Additional Information


FSCOWS@1.1001:OAuth2CheckBaseUri Permanent link for this heading

Public Extension Point for Checking the Base URI

object FSCOWS@1.1001:OAuth2CheckBaseUri(
  string oa2baseuri,
  out retval object errormsg)

Name

Description

oa2baseuri

errormsg

Additional Information


FSCOWS@1.1001:OAuth2CreatePostBody Permanent link for this heading

content FSCOWS@1.1001:OAuth2CreatePostBody(
  dictionary reqdict,
  out optional string reqbodytxt,
  out retval content reqbody)

Name

Description

reqdict

reqbodytxt

reqbody

Additional Information


FSCOWS@1.1001:OAuth2GenerateResultURIFromError Permanent link for this heading

Public Extension Point to Generate a Redirect URI in case we received an Error from Authentication

string FSCOWS@1.1001:OAuth2GenerateResultURIFromError(
  string error,
  string error_description,
  out retval string rediruri)

Name

Description

error

error_description

rediruri

The resulting RedirectURI

Additional Information


FSCOWS@1.1001:OAuth2GenerateResultURIFromTokenResult Permanent link for this heading

Public Extension Point for Generating the Result URI in Case of a Success

string FSCOWS@1.1001:OAuth2GenerateResultURIFromTokenResult(
  OAuth2HttpResponse response,
  out retval string rediruri)

Name

Description

response

The OAuth2HttpResponse to convert to an URI

rediruri

The resulting RedirectURI

Additional Information


FSCOWS@1.1001:OAuth2GenerateState Permanent link for this heading

Public Extension Point for Generating the State

string FSCOWS@1.1001:OAuth2GenerateState(
  out retval string state)

Name

Description

state

The resulting State

Additional Information


FSCOWS@1.1001:OAuth2PrepareAuthRedirURI Permanent link for this heading

Public Extension Point for Modifying the Redirect URI

string FSCOWS@1.1001:OAuth2PrepareAuthRedirURI(
  dictionary headers,
  dictionary urlparams,
  out retval string rediruri)

Name

Description

headers

urlparams

rediruri

URI to redirect to

Additional Information


FSCOWS@1.1001:OAuth2PrepareHeaders Permanent link for this heading

Public Extension Point for Preparing the Request Headers with optional Bearer Token

dictionary FSCOWS@1.1001:OAuth2PrepareHeaders(
  string contenttype,
  optional string accesstoken,
  out retval dictionary reqhdrs)

Name

Description

contenttype

accesstoken

reqhdrs

Additional Information


FSCOWS@1.1001:OAuth2SendHTTPRequest Permanent link for this heading

Public Exension Point to modify how to send an HTTP Request to the OAuth2 Service

void FSCOWS@1.1001:OAuth2SendHTTPRequest(
  string amethod,
  string uri,
  dictionary reqhdrs,
  content reqbody,
  out dictionary respheaders,
  out content respbody)

Name

Description

amethod

The HTTP Method (PUT, POST,..)

uri

reqhdrs

reqbody

respheaders

respbody

Additional Information


FSCOWS@1.1001:OAuth2StoreInUserSettings Permanent link for this heading

Public Extension Point for storing required Parameters in Usersettings

void FSCOWS@1.1001:OAuth2StoreInUserSettings(
  dictionary headers,
  dictionary urlparams,
  integer expiresin)

Name

Description

headers

urlparams

expiresin

Additional Information


FSCOWS@1.1001:OAuthAuthorize Permanent link for this heading

string FSCOWS@1.1001:OAuthAuthorize(
  object client,
  object[] scope,
  out retval string code,
  out boolean trusted,
  ref optional string redirecturi,
  optional AuthMeth authmeth,
  optional string ipaddress)

Name

Description

client

scope

code

trusted

redirecturi

authmeth

ipaddress

Additional Information


FSCOWS@1.1001:OAuthCheckToken Permanent link for this heading

void FSCOWS@1.1001:OAuthCheckToken(
  string token,
  out object[] scope,
  out AuthMeth authmeth)

Name

Description

token

scope

authmeth

Additional Information


FSCOWS@1.1001:OAuthConfirm Permanent link for this heading

void FSCOWS@1.1001:OAuthConfirm(
  object client,
  string code,
  optional boolean usesecclearance)

Name

Description

client

code

usesecclearance

Additional Information


FSCOWS@1.1001:OAuthGetTokenExpiration Permanent link for this heading

OAuthTokenExpiration FSCOWS@1.1001:OAuthGetTokenExpiration(
  object client,
  out retval OAuthTokenExpiration expiration)

Name

Description

client

expiration

Additional Information


FSCOWS@1.1001:PostXML Permanent link for this heading

Posts an XML document to the specified URL. This action is obsolete, use SendHttpRequest or SendHttpTextRequest instead.

void FSCOWS@1.1001:PostXML(
  string url,
  string object,
  string action,
  any xmlin,
  out content xmlout,
  optional integer parentwindow,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer timeoutresolve,
  optional integer timeoutconnect,
  optional integer timeoutsend,
  optional integer timeoutreceive,
  optional boolean ignorehttperrors,
  optional boolean usevappproxysettings,
  optional ContentObject cacert)

Name

Description

url

object

action

xmlin

xmlout

parentwindow

user

password

proxyuser

proxypassword

clientcert

timeoutresolve

timeoutconnect

timeoutsend

timeoutreceive

ignorehttperrors

usevappproxysettings

cacert

Additional Information


FSCOWS@1.1001:ProcessHttpSoapMessage Permanent link for this heading

Process a SOAP message received over HTTP.

void FSCOWS@1.1001:ProcessHttpSoapMessage(
  dictionary requesthttpheaders,
  content requesthttpbody,
  optional dictionary requestoptions,
  out integer actionresult,
  out dictionary responsehttpheaders,
  out content responsehttpbody,
  out boolean responseisfault)

Name

Description

requesthttpheaders

A DICTIONARY containing the HTTP request's HTTP header as key value pairs.

requesthttpbody

The HTTP request's body as CONTENT.

requestoptions

Options for the HTTP request as DICTIONARY.

actionresult

responsehttpheaders

The received HTTP response's HTTP headers as DICTIONARY.

responsehttpbody

The received HTTP response's body as CONTENT.

responseisfault

Additional Information


FSCOWS@1.1001:RenewServiceToken Permanent link for this heading

void FSCOWS@1.1001:RenewServiceToken(
  optional integer key)

Name

Description

key

Additional Information


FSCOWS@1.1001:SendHttpRequest Permanent link for this heading

Send an HTTP request to the specified endpoint. If the data involved is text only, consider using SendHttpTextRequest.

void FSCOWS@1.1001:SendHttpRequest(
  string verb,
  string url,
  optional dictionary reqheaders,
  optional content reqbody,
  out optional dictionary respheaders,
  out optional content respbody,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer timeoutresolve,
  optional integer timeoutconnect,
  optional integer timeoutsend,
  optional integer timeoutreceive,
  optional boolean ignorehttperrors,
  optional boolean usevappproxysettings,
  optional ContentObject cacert)

Name

Description

verb

The HTTP method which is to be used in the HTTP request.

url

The URL endpoint for the HTTP request.

reqheaders

A DICTIONARY which is used to specify the HTTP requests' headers as key value pairs. e.g. "X-MyHeader: MyValue".

reqbody

The HTTP request's body content.

respheaders

The received HTTP response's HTTP headers as DICTIONARY.

respbody

The received HTTP response's body as content.

user

The username used for basic authentication.

password

The password used for basic authentication.

proxyuser

The username used for basic authentication at the proxy server. This parameter is obsolete and must not be used any more. A proxy should be configured in the vApp Configuration.

proxypassword

The password used for basic authentication at the proxy server. This parameter is obsolete and must not be used any more. A proxy should be configured in the vApp Configuration.

clientcert

The client certificate object used for client certificate authentication.

timeoutresolve

Resolve timeout (in seconds) for the given URL.

timeoutconnect

Connection timeout (in seconds) for the given URL.

timeoutsend

Upload timeout (in seconds) for the HTTP request.

timeoutreceive

Download timeout (in seconds) for the HTTP response.

ignorehttperrors

Do not throw an exception if an http error (http status code equal or greater than 300) occurs. If this parameter is specified and true, the caller is responsible for interpreting the http status code. The http status code and the http status text are provided in the DICTIONARY of parameter respheaders using the entries __httpcode and __httpstatus. Additionally the entry __httptext contains the response text in case of an error.

usevappproxysettings

Use the proxy settings defined in the current vApp Configuration (DefaultConfiguration). The vApp Configuration is only used if proxyuser is null or empty.

cacert

Content object containing a CA certificate bundle to validate the server (PEM format, complete CA chain to server certificate).

Additional Information


FSCOWS@1.1001:SendHttpRequestEx Permanent link for this heading

Send an HTTP request to the specified endpoint. If the data involved is text only, consider using SendHttpTextRequest.

void FSCOWS@1.1001:SendHttpRequestEx(
  string verb,
  string url,
  optional dictionary reqheaders,
  optional any reqbody,
  out optional dictionary respheaders,
  ref optional any respbody,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer timeoutresolve,
  optional integer timeoutconnect,
  optional integer timeoutsend,
  optional integer timeoutreceive,
  optional boolean ignorehttperrors,
  optional boolean usevappproxysettings,
  optional ContentObject cacert)

Name

Description

verb

The HTTP method which is to be used in the HTTP request.

url

The URL endpoint for the HTTP request.

reqheaders

A DICTIONARY which is used to specify the HTTP requests' headers as key value pairs. e.g. "X-MyHeader: MyValue".

reqbody

The HTTP request's body content or string.

respheaders

The received HTTP response's HTTP headers as DICTIONARY.

respbody

The received HTTP response's body as content or string. Pass in a valid content to use contents.

user

The username used for basic authentication.

password

The password used for basic authentication.

proxyuser

The username used for basic authentication at the proxy server. This parameter is obsolete and must not be used any more. A proxy should be configured in the vApp Configuration.

proxypassword

The password used for basic authentication at the proxy server. This parameter is obsolete and must not be used any more. A proxy should be configured in the vApp Configuration.

clientcert

The client certificate object used for client certificate authentication.

timeoutresolve

Resolve timeout (in seconds) for the given URL.

timeoutconnect

Connection timeout (in seconds) for the given URL.

timeoutsend

Upload timeout (in seconds) for the HTTP request.

timeoutreceive

Download timeout (in seconds) for the HTTP response.

ignorehttperrors

Do not throw an exception if an http error (http status code equal or greater than 300) occurs. If this parameter is specified and true, the caller is responsible for interpreting the http status code. The http status code and the http status text are provided in the DICTIONARY of parameter respheaders using the entries __httpcode and __httpstatus. Additionally the entry __httptext contains the response text in case of an error.

usevappproxysettings

Use the proxy settings defined in the current vApp Configuration (DefaultConfiguration). The vApp Configuration is only used if proxyuser is null or empty.

cacert

Content object containing a CA certificate bundle to validate the server (PEM format, complete CA chain to server certificate).

Additional Information


FSCOWS@1.1001:SendHttpSoapMessage Permanent link for this heading

Send a SOAP message over HTTP POST.

void FSCOWS@1.1001:SendHttpSoapMessage(
  string url,
  SoapTransport coding,
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer resolvetimeout,
  optional integer connecttimeout,
  optional integer sendtimeout,
  optional integer receivetimeout,
  optional dictionary additionaloptions,
  optional boolean usevappproxysettings,
  optional boolean noparsefile,
  optional ContentObject cacert)

Name

Description

url

The URL endpoint for the HTTP request.

coding

The SOAP encoding used for the HTTP request.

httpheadersin

A DICTIONARY which is used to specify the HTTP requests' headers as key value pairs. e.g. "X-MyHeader: MyValue".

soapheadersin

A list of contents which are included in the SOAP header section of the HTTP request. Therefore, these contents have to be wellformed XML.

soapbodyin

The content used as SOAP payload. This content has to be wellformed XML.

soapattachmentsin

A list of contents which are used as SOAP attachments.

httpheadersout

A DICTIONARY containing the received HTTP response's HTTP headers.

soapheadersout

A list of contents containing the received HTTP response's SOAP headers.

soapbodyout

The received HTTP response's body as content.

soapattachmentsout

A list of contents containing the received HTTP response's SOAP attachments.

user

The username used for basic authentication.

password

The password used for basic authentication.

proxyuser

The username used for basic authentication at the proxy server.

proxypassword

The password used for basic authentication at the proxy server.

clientcert

The client certificate object used for client certificate authentication.

resolvetimeout

Resolve timeout (in seconds) for the HTTP request.

connecttimeout

Connection timeout (in seconds) for the HTTP request.

sendtimeout

Upload timeout (in seconds) for the HTTP request.

receivetimeout

Download timeout (in seconds) for the HTTP response.

additionaloptions

Additional options for the SOAP request. Internal use.

usevappproxysettings

Use the proxy settings defined in the current vApp Configuration (DefaultConfiguration). The vApp Configuration is only used if proxyuser is null or empty.

noparsefile

COOGF_NOPARSEFILE option for SOAP attachments.

cacert

Content object containing a CA certificate bundle to validate the server (PEM format, complete CA chain to server certificate).

Additional Information


FSCOWS@1.1001:SendHttpTextRequest Permanent link for this heading

Send an HTTP request to the specified endpoint. This action is optimized for sending/receiving text data like JSON or XML. To send/receive a generic content, use SendHttpRequest.

void FSCOWS@1.1001:SendHttpTextRequest(
  string verb,
  string url,
  optional dictionary reqheaders,
  optional string reqbody,
  out optional dictionary respheaders,
  out optional string respbody,
  optional string user,
  optional string password,
  optional string proxyuser,
  optional string proxypassword,
  optional ContentObject clientcert,
  optional integer timeoutresolve,
  optional integer timeoutconnect,
  optional integer timeoutsend,
  optional integer timeoutreceive,
  optional boolean ignorehttperrors,
  optional boolean usevappproxysettings,
  optional ContentObject cacert)

Name

Description

verb

The HTTP method which is to be used in the HTTP request.

url

The URL endpoint for the HTTP request.

reqheaders

A DICTIONARY which is used to specify the HTTP requests' headers as key value pairs. e.g. "X-MyHeader: MyValue".

reqbody

The HTTP request's body text.

respheaders

The received HTTP response's HTTP headers as DICTIONARY.

respbody

The received HTTP response's body text.

user

The username used for basic authentication.

password

The password used for basic authentication.

proxyuser

The username used for basic authentication at the proxy server. This parameter is obsolete and must not be used any more. A proxy should be configured in the vApp Configuration.

proxypassword

The password used for basic authentication at the proxy server. This parameter is obsolete and must not be used any more. A proxy should be configured in the vApp Configuration.

clientcert

The client certificate object used for client certificate authentication.

timeoutresolve

Resolve timeout (in seconds) for the given URL.

timeoutconnect

Connection timeout (in seconds) for the given URL.

timeoutsend

Upload timeout (in seconds) for the HTTP request.

timeoutreceive

Download timeout (in seconds) for the HTTP response.

ignorehttperrors

Do not throw an exception if an http error (http status code equal or greater than 300) occurs. If this parameter is specified and true, the caller is responsible for interpreting the http status code. The http status code and the http status text are provided in the DICTIONARY of parameter respheaders using the entries __httpcode and __httpstatus. Additionally the entry __httptext contains the response text in case of an error.

usevappproxysettings

Use the proxy settings defined in the current vApp Configuration (DefaultConfiguration). The vApp Configuration is only used if proxyuser is null or empty.

cacert

Content object containing a CA certificate bundle to validate the server (PEM format, complete CA chain to server certificate).

Additional Information


FSCOWS@1.1001:ServiceTokenAccessPending Permanent link for this heading

void FSCOWS@1.1001:ServiceTokenAccessPending(
  optional string ipaddress,
  optional string useragent,
  optional string urlpath)

Name

Description

ipaddress

useragent

urlpath

Additional Information


FSCOWS@1.1001:ServiceTokenExpirationPending Permanent link for this heading

void FSCOWS@1.1001:ServiceTokenExpirationPending(
  ServiceTokenAccess[] tokenaccess)

Name

Description

tokenaccess

Additional Information


FSCOWS@1.1001:ServiceTokenInvalid Permanent link for this heading

void FSCOWS@1.1001:ServiceTokenInvalid(
  optional ServiceTokenAccess tokenaccess,
  optional string ipaddress,
  optional string useragent,
  optional string urlpath)

Name

Description

tokenaccess

ipaddress

useragent

urlpath

Additional Information


FSCOWS@1.1001:SOAPAbort Permanent link for this heading

To explicitly abort a SOAP transaction, this SOAP action can be called. The SOAP transaction is specified via the SOAP header.

void FSCOWS@1.1001:SOAPAbort()

Additional Information


FSCOWS@1.1001:SOAPCommit Permanent link for this heading

To explicitly commit a SOAP transaction using a distinct roundtrip to the web server, this SOAP action can be called.

void FSCOWS@1.1001:SOAPCommit()

Additional Information


FSCOWS@1.1001:SOAPCreateContentObjects Permanent link for this heading

SOAP web service used to create a content object.

void FSCOWS@1.1001:SOAPCreateContentObjects(
  any xmlin,
  out content xmlout)

Name

Description

xmlin

xmlout

Additional Information


FSCOWS@1.1001:Value2MIME Permanent link for this heading

Generate a value from a MIME content.

content FSCOWS@1.1001:Value2MIME(
  NamedPart value,
  ref string contenttype,
  out retval content mime)

Name

Description

value

the structured values.

contenttype

the contenttype. If valid on input, the contenttype is ignored and the contenttype header is written to mime.

mime

the mime content

Additional Information


FSCOWS@1.1001:WebDAVFriendlyURL Permanent link for this heading

void FSCOWS@1.1001:WebDAVFriendlyURL()

Additional Information


FSCOWS@1.1001:WebDAVObjectChangeClass Permanent link for this heading

void FSCOWS@1.1001:WebDAVObjectChangeClass(
  object oldclass,
  object newclass)

Name

Description

oldclass

newclass

Additional Information


FSCOWS@1.1001:WebDAVObjectModified Permanent link for this heading

void FSCOWS@1.1001:WebDAVObjectModified(
  ref object modifiedobj,
  object parentviewattr,
  string webdavmethod,
  integer contentsizebefore,
  integer contentsizeafter)

Name

Description

modifiedobj

parentviewattr

webdavmethod

contentsizebefore

contentsizeafter

Additional Information


FSCOWS@1.1001:WOPIGetUserStatus Permanent link for this heading

Determine user status.

void FSCOWS@1.1001:WOPIGetUserStatus(
  object document,
  ref WOPIUserStatus status)

Name

Description

document

the document to be accessed

status

the user status (e.g. business, educational)

Additional Information


FSCOWS@1.1001:WOPISessionClose Permanent link for this heading

Close a WOPI session: access_token is not usable thereafter.

void FSCOWS@1.1001:WOPISessionClose(
  string access_token)

Name

Description

access_token

the access_token

Additional Information


FSCOWS@1.1001:WOPISessionCreate Permanent link for this heading

Create a WOPI session: access_token to be used with a WOPISrcUrl to work with a document.

void FSCOWS@1.1001:WOPISessionCreate(
  out string access_token,
  out integer access_tokenttl,
  optional datetime access_expiresat)

Name

Description

access_token

the access_token

access_tokenttl

the access_token ttl

access_expiresat

the maximum lifetime of the token, the default uses session defaults.

Additional Information


FSCOWS@1.1001:WOPIURLSrcGet Permanent link for this heading

Use WOPI discovery to get the urlsrc to work with a document.
(See current values at https://onenote.officeapps.live.com/hosting/discovery)
(See documentation at https://wopi.readthedocs.io/en/latest/discovery.html#discovery)

void FSCOWS@1.1001:WOPIURLSrcGet(
  out string urlsrc,
  out string favicon,
  optional string wopiaction,
  optional string wopiextension,
  optional string wopiapplication,
  optional string wopinetzone)

Name

Description

urlsrc

the urlsrc

favicon

the favicon

wopiaction

the wopiaction (e.g. "view", "edit". default is "view").

wopiextension

the wopiextension (e.g. "xlsx". default is content.contextension ).

wopiapplication

the wopiapplication (e.g. "Excel" (if empty the filter is not applied)

wopinetzone

the wopinetzone (e.g. "external-https" (if emmpty the filter is not applied)

Additional Information


FSCOWS@1.1001:WSJSONFriendlyURL Permanent link for this heading

void FSCOWS@1.1001:WSJSONFriendlyURL(
  string definition,
  string operation,
  content request,
  out string response)

Name

Description

definition

operation

request

response

Additional Information


FSCOWS@1.1001:XeditorGetLockTargets Permanent link for this heading

Hook to retrieve additional objects for the lock handling of Xeditor documents. The object itself is already locked when called. This is called for ObjectLock, ObjectUnlock, ObjectRelock and ObjectLockRefresh.

object[] FSCOWS@1.1001:XeditorGetLockTargets(
  out retval object[] locktargets,
  Action operation)

Name

Description

locktargets

operation

Additional Information


FSCOWS@1.1001:XeditorRead Permanent link for this heading

Hook to patch content read for Xeditor.

void FSCOWS@1.1001:XeditorRead(
  ref Content content,
  AttributeDefinition attrdef)

Name

Description

content

the content

attrdef

the attribute @see TV_XEDITOR_ARGUMENTS

Additional Information


FSCOWS@1.1001:XeditorSessionClose Permanent link for this heading

Close a Xeditor session: access_token is not usable thereafter.

void FSCOWS@1.1001:XeditorSessionClose(
  string access_token)

Name

Description

access_token

the access_token

Additional Information


FSCOWS@1.1001:XeditorSessionCreate Permanent link for this heading

Create a Xeditor session: access_token to be used with a url returnd from XeditorURLSrcGet work with a document.

void FSCOWS@1.1001:XeditorSessionCreate(
  out string access_token,
  out integer access_tokenttl,
  optional datetime access_expiresat)

Name

Description

access_token

the access_token

access_tokenttl

the access_token ttl

access_expiresat

the maximum lifetime of the token, the default uses session defaults.

Additional Information


FSCOWS@1.1001:XeditorURLSrcGet Permanent link for this heading

Use Xeditor configuration to get the urlsrc to work with a document.

string FSCOWS@1.1001:XeditorURLSrcGet(
  out retval string urlsrc)

Name

Description

urlsrc

the url to open the editor.

Additional Information


FSCOWS@1.1001:XeditorWrite Permanent link for this heading

Hook to patch content write for Xeditor.

void FSCOWS@1.1001:XeditorWrite(
  ref Content content,
  AttributeDefinition attrdef)

Name

Description

content

the content

attrdef

the attribute @see TV_XEDITOR_ARGUMENTS

Additional Information