Actions of FSCOWSSTDSERVICES@1.1001

Return Type	Signature
void	AddObjectRemark( object obj, optional string textremark, optional string event, optional datetime timestamp, optional AttachmentType[] attachments)
LicenseCheck	CheckAppLicense( out retval LicenseCheck licenseinfo, string appref, optional boolean setappactivated)
LicenseCheck	CheckAppLicenseSimple( out retval LicenseCheck licenseinfo, string appref)
JSAPIMobileAppVersion	CheckMobileAppVersion( App app, string platform, out retval JSAPIMobileAppVersion mobileappversion)
string	CreateChangeSubscription( out retval string subscription)
void	DeleteChangeSubscription( object subscription)
dictionary	GetChangedObjects( ref datetime refdate, ref optional string[] objects, optional boolean system, optional string subscription, optional integer version, optional string[] attrlist, out retval dictionary response)
UserData	GetCurrentUser( out retval UserData userdata, optional boolean includewebservices, optional boolean includefriendlyurls)
void	GetDeleteAction( object container, object[] selobjects, integer lastresult, out string caption, out string question, out boolean enhanced, ref object delaction, optional boolean shiftkeypressed, ref optional object deltarget, ref optional object delapplication)
UserFeature[]	GetExtendedUserFeatures( out retval UserFeature[] userfeatures)
Language	GetLanguageFromCountrycode( string countrycode, out retval Language lang)
Locale	GetLocaleFromCountryCode( string countrycode, out retval Locale locale)
JSAPIMindbreezeFacetValues[]	GetMindbreezeFacetPropValues( object obj, JSAPIMindbreezeFacet[] facets, out retval JSAPIMindbreezeFacetValues[] result, out JSAPIError[] errors)
dictionary	GetMindbreezeQueryConstraints( object obj, out retval dictionary queryconstraints)
MobileTaskPaneMenu[]	GetMobileTaskPaneMenus( object containerobject, optional AttributeDefinition containerview, optional object selectedobject, optional Breadcrumb[] breadcrumb, out retval MobileTaskPaneMenu[] result, out JSAPIError[] errors)
History[]	GetObjectHistory( object obj, out retval History[] history)
content	GetObjectRemarks( object obj, out retval content remarks)
JSAPIObjectStateDisplay[]	GetObjectStateDisplay( object obj, optional AttributeDefinition attrdef, optional boolean strict, object[] entries, optional boolean important, out retval JSAPIObjectStateDisplay[] result, out JSAPIError[] errors)
ObjectInfo[]	GetSearchFolderResults( GenericStoredQBOL searchfolder, optional boolean refresh, optional boolean keysonly, out retval ObjectInfo[] response)
UserData	GetUserData( out retval UserData userdata, optional boolean includewebservices, optional boolean includefriendlyurls)
UserRoleData	GetUserRoleData( out retval UserRoleData result)
content	HttpGet( string url, out retval content response, optional boolean nocert)
content	HttpPost( string url, content data, out retval content response, optional boolean nocert)
Address	JSON2Address( string json, out retval Address address)
UserAppList[]	JSON2Products( string json, optional boolean ignorehiddenapps, out retval UserAppList[] products, out optional object primaryproduct, out optional boolean istrial)
Language	SetRequestLanguage( string lang, out retval Language requestlang, out Language origlang)
Locale	SetRequestLocale( string locale, out retval Locale requestlocale)
void	UpdateChangeSubscriptionObjects( object subscription, string[] add, string[] remove, boolean reset, ref datetime changedat, out integer errorcount)

FSCOWSSTDSERVICES@1.1001:AddObjectRemark

Adds a remark including attachments to an object Alternatively - especially for larger files - attachment can be uploaded via WebDAV PUTting a file to a URL like http(s)://urlhead/webdav/[<b>COO.x.y.a.b</b>-FSCFOLIO_1_100_boaddreferences]/<b>Screenshot.jpg</b> where
- COO.x.y.a.b is the object where the remark should be added
- Screenshot.jpg is the name and extension of the document to import

void FSCOWSSTDSERVICES@1.1001:AddObjectRemark(
  object obj,
  optional string textremark,
  optional string event,
  optional datetime timestamp,
  optional AttachmentType[] attachments)

Name	Description
obj	the object
textremark	the user entered text of the remark
event	the textual description of the remark
timestamp	the timestamp of the remark
attachments	the list of attachments assigned to the remark

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:CheckAppLicense

Checks whether an app is licensed for the current user and can change the activation state

LicenseCheck FSCOWSSTDSERVICES@1.1001:CheckAppLicense(
  out retval LicenseCheck licenseinfo,
  string appref,
  optional boolean setappactivated)

Name	Description
licenseinfo	the license info
appref	a fully qualified reference or a coo address of an app
setappactivated	can change the activation state

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:CheckAppLicenseSimple

Checks whether an app is licensed for the current only without activating it.

LicenseCheck FSCOWSSTDSERVICES@1.1001:CheckAppLicenseSimple(
out retval LicenseCheck licenseinfo,
string appref)

Name	Description
licenseinfo	the license info
appref	a fully qualified reference or a coo address of an app

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:CheckMobileAppVersion

Checks the latest available mobile app for a certain mobile platform and returns the mandatory version, currentversion and link to the shop, where the new app can be downloaded.

JSAPIMobileAppVersion FSCOWSSTDSERVICES@1.1001:CheckMobileAppVersion(
  App app,
  string platform,
  out retval JSAPIMobileAppVersion mobileappversion)

Name	Description
app	coo address of a cloud app
platform	string with the name of the platform
mobileappversion	struct that contains the available mobile app versions

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:CreateChangeSubscription

Creates a new change subscription

string FSCOWSSTDSERVICES@1.1001:CreateChangeSubscription(
out retval string subscription)

Name	Description
subscription	the created change subscription

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:DeleteChangeSubscription

Deletes a change subscription

void FSCOWSSTDSERVICES@1.1001:DeleteChangeSubscription(
object subscription)

Name	Description
subscription	the change subscription

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetChangedObjects

Determines from a list of objects or object addresses which objects are changed since refdate.

dictionary FSCOWSSTDSERVICES@1.1001:GetChangedObjects(
  ref datetime refdate,
  ref optional string[] objects,
  optional boolean system,
  optional string subscription,
  optional integer version,
  optional string[] attrlist,
  out retval dictionary response)

Name	Description
refdate	`in`: Date and time used for date comparision. `out`: Date and time until modifications are considered
objects	`in`: List of objects or object addresses to check. `out`: List of objects or object addresses which are changed since `refdate`
system	`true` if also noteless changes should be included
subscription	the change subscription to be checked for changes
version	the response version (default: version 1)
attrlist	the attributes which should be included in the response (version 2 only)
response

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetCurrentUser

Retrieves information about the current user.
See GetUserData.

UserData FSCOWSSTDSERVICES@1.1001:GetCurrentUser(
  out retval UserData userdata,
  optional boolean includewebservices,
  optional boolean includefriendlyurls)

Name	Description
userdata	Contains the user data.
includewebservices	When true, all web service definitions will be iterated and provide information about the implemented web service actions via feature detection.
includefriendlyurls	When true, all friendlyurlconfigs will be iterated and provide information about the implemented friendlyurl actions via feature detection.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetDeleteAction

Web service wrapper for GetDeleteAction.

void FSCOWSSTDSERVICES@1.1001:GetDeleteAction(
  object container,
  object[] selobjects,
  integer lastresult,
  out string caption,
  out string question,
  out boolean enhanced,
  ref object delaction,
  optional boolean shiftkeypressed,
  ref optional object deltarget,
  ref optional object delapplication)

Name	Description
container
selobjects
lastresult
caption
question
enhanced
delaction
shiftkeypressed
deltarget
delapplication

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetExtendedUserFeatures

Can be used to extend the user features.
Should be post wrapped by other software components.

UserFeature[] FSCOWSSTDSERVICES@1.1001:GetExtendedUserFeatures(
out retval UserFeature[] userfeatures)

Name	Description
userfeatures	Contains the list of user features.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetLanguageFromCountrycode

Returns a language object regarding to the parameter countrycode.

Language FSCOWSSTDSERVICES@1.1001:GetLanguageFromCountrycode(
string countrycode,
out retval Language lang)

Name	Description
countrycode	The countrycode can either be an object address or an language string (e.g. "de" or "de-at")
lang

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetLocaleFromCountryCode

Returns a locale object regarding to the parameter countrycode.

Locale FSCOWSSTDSERVICES@1.1001:GetLocaleFromCountryCode(
string countrycode,
out retval Locale locale)

Name	Description
countrycode	The countrycode can either be an object address or an language string (e.g. "en" or "en-US")
locale

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetMindbreezeFacetPropValues

JSAPIMindbreezeFacetValues[] FSCOWSSTDSERVICES@1.1001:GetMindbreezeFacetPropValues(
  object obj,
  JSAPIMindbreezeFacet[] facets,
  out retval JSAPIMindbreezeFacetValues[] result,
  out JSAPIError[] errors)

Name	Description
obj
facets
result
errors

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetMindbreezeQueryConstraints

Calls the actual implementation GetMindbreezeQueryConstraintsImpl.
Will build the required arguments using the coo address of the given object and some specific defaults.
The default for the Mindbreeze Query Constraint is MQC_GENERAL.
The default for the id of the search result is "ignore".

dictionary FSCOWSSTDSERVICES@1.1001:GetMindbreezeQueryConstraints(
object obj,
out retval dictionary queryconstraints)

Name	Description
obj	the current object for which mindbreeze query constraints should be returned.
queryconstraints	the query constraints which will be passed from the base method. @see GetMindbreezeQueryConstraintsImpl @see MQC_GENERAL

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetMobileTaskPaneMenus

Retrieves all task pane menus which are available for mobile apps via GetMobileTaskPaneMenus.

MobileTaskPaneMenu[] FSCOWSSTDSERVICES@1.1001:GetMobileTaskPaneMenus(
  object containerobject,
  optional AttributeDefinition containerview,
  optional object selectedobject,
  optional Breadcrumb[] breadcrumb,
  out retval MobileTaskPaneMenu[] result,
  out JSAPIError[] errors)

Name	Description
containerobject	The object (compound object) for which the menus are calculated, or the parent of the selected object (content object) for which the menus are calculated.
containerview	The view (attribute definition) for which the menus are calculated, or the parent view of the selected object (content object) for which the menus are calculated. Optional: This parameter should only be set if menus for a specific attribute (list) are calculated.
selectedobject	The object (content object) for which the menus are calculated. Optional: This parameter should only be set if menus for content objects (preview) are calculated.
breadcrumb	A list of breadcrumbs (Breadcrumb). Optional: If this parameter is not set, GetBreadCrumb will be used to calculate the breadcrumb list.
result	The result containing a list of menus.
errors	A list of errors if some occurred. @see GetMobileTaskPaneMenus @see GetTaskPaneMenuStructList @see GetBreadCrumb

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetObjectHistory

Retrieves the history for an object

History[] FSCOWSSTDSERVICES@1.1001:GetObjectHistory(
object obj,
out retval History[] history)

Name	Description
obj	the object address of the object
history	the history of the object

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetObjectRemarks

Retrieves the remarks content for an object

content FSCOWSSTDSERVICES@1.1001:GetObjectRemarks(
object obj,
out retval content remarks)

Name	Description
obj	the id or the object address of the Object
remarks	the remarks content

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetObjectStateDisplay

Retrieves the object state displays for the defined object entries within attrdef of object.
Sets the transaction variables TV_SELECTIONCONTEXT and TV_SELECTIONCONTAINER with obj as selcontainer, attrdef as selview and selviewmode to DISP_EXPLORE as this is required for the customization points.

JSAPIObjectStateDisplay[] FSCOWSSTDSERVICES@1.1001:GetObjectStateDisplay(
  object obj,
  optional AttributeDefinition attrdef,
  optional boolean strict,
  object[] entries,
  optional boolean important,
  out retval JSAPIObjectStateDisplay[] result,
  out JSAPIError[] errors)

Name	Description
obj	object address of the parent object.
attrdef	attribute definition for which the object state displays should be evaluated. If no attribute definition is provided, GetFormViews will be evaluated and the first attribute which is available on the object will be taken into consideration.
strict	If `true` and no attribute definition is provided and the evaluation of GetFormViews() provides more then one attribute available an error will be thrown. If `false` and no attribute definition is provided, the first attribute returned by GetFormViews() will be used. if `attrdef` is defined, this has no meaning.
entries	If entries are defined, only those will be evaluated. If no entries are defined, all entries from within attrdef of object will be evaluated.
important	If `true`, only important object state displays will be returned. If `false`, all object state displays will be returned.
result	result containing the object state displays for the entries.
errors	list of errors if some occurred. @see DisplayMode

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetSearchFolderResults

Retrieves the search result of the specified search folder. The search can be refreshed using the refresh flag.

ObjectInfo[] FSCOWSSTDSERVICES@1.1001:GetSearchFolderResults(
  GenericStoredQBOL searchfolder,
  optional boolean refresh,
  optional boolean keysonly,
  out retval ObjectInfo[] response)

Name	Description
searchfolder	the search folder to interact with
refresh	refresh before data is collected
keysonly	return only object keys
response

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetUserData

Retrieves information about a user.
The information consists of objaddress, title, name and other user related properties.
The result from GetBrandingLayout is included in udbranding. It provides information on how to brand the client according to the users branding. (can not be used via SOAP)
It also contains a feature detection which can be used by the calling client to determine which options to provide.
The feature detection includes information about:

aspect (relevant for CMIS)
basetypefolder (relevant for CMIS)
linkdelegation (contains 2 boolean flags for active and default)
domaintype (contains one of the three domain types "Cloud", "Folio" and "eGov")
supportedannotationapiversions (contains a list of supported PDF Annotation API versions)
usevappsonmobile (boolean, true, when vApps can be used on mobile clients)
canusepushnotifications (boolean, true, when push notifications can be used)
psinsightappsavailable (boolean, true, when psinsightapps attribute is available for FSCMINBREEZE@1.1011:PortalSearch)
all implemented web service actions (optional, when parameter includewebservices is set to true)
all implemented friendlyurl actions (optional, when parameter includefriendlyurls is set to true)

Must be called on objects of type User.

UserData FSCOWSSTDSERVICES@1.1001:GetUserData(
  out retval UserData userdata,
  optional boolean includewebservices,
  optional boolean includefriendlyurls)

Name	Description
userdata	Contains the user data.
includewebservices	When true, all web service definitions will be iterated and provide information about the implemented web service actions via feature detection.
includefriendlyurls	When true, all friendlyurlconfigs will be iterated and provide information about the implemented friendlyurl actions via feature detection.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:GetUserRoleData

Retrieves information about the roles of the user.

UserRoleData FSCOWSSTDSERVICES@1.1001:GetUserRoleData(
out retval UserRoleData result)

Name	Description
result	Contains the user role data.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:HttpGet

Executes a simple HTTP get request. The proxy settings from the current vApp configuration are processed.

content FSCOWSSTDSERVICES@1.1001:HttpGet(
  string url,
  out retval content response,
  optional boolean nocert)

Name	Description
url	the url send via HTTP get
response	the content containing an UTF8 string retrieved by the HTTP get request
nocert

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:HttpPost

Executes a simple HTTP post request The proxy settings from the current vApp configuration are processed.

content FSCOWSSTDSERVICES@1.1001:HttpPost(
  string url,
  content data,
  out retval content response,
  optional boolean nocert)

Name	Description
url	the url send via HTTP post
data	the content containing an UTF8 string send via HTTP post
response	the content containing an UTF8 string retrieved by the HTTP post request
nocert

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:JSON2Address

Address FSCOWSSTDSERVICES@1.1001:JSON2Address(
string json,
out retval Address address)

Name	Description
json
address

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:JSON2Products

Resolve a json to a product list

UserAppList[] FSCOWSSTDSERVICES@1.1001:JSON2Products(
  string json,
  optional boolean ignorehiddenapps,
  out retval UserAppList[] products,
  out optional object primaryproduct,
  out optional boolean istrial)

Name	Description
json	the input values
ignorehiddenapps	hidden apps will be reurned or ignored
products	the products
primaryproduct	the primary product
istrial

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:SetRequestLanguage

Sets the lang as the language for the current user

Language FSCOWSSTDSERVICES@1.1001:SetRequestLanguage(
  string lang,
  out retval Language requestlang,
  out Language origlang)

Name	Description
lang	the lang
requestlang
origlang

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:SetRequestLocale

Sets the locale as the locale for the current user

Locale FSCOWSSTDSERVICES@1.1001:SetRequestLocale(
string locale,
out retval Locale requestlocale)

Name	Description
locale	the locale
requestlocale

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001

FSCOWSSTDSERVICES@1.1001:UpdateChangeSubscriptionObjects

Updates objects of a given change subscription. In case of success the transaction will be committed.

void FSCOWSSTDSERVICES@1.1001:UpdateChangeSubscriptionObjects(
  object subscription,
  string[] add,
  string[] remove,
  boolean reset,
  ref datetime changedat,
  out integer errorcount)

Name	Description
subscription	the change subscription
add	the change subscription objects to be added
remove	the change subscription objects to be removed. Objects contained in both add and remove are removed.
reset	if the subscription objects should be reset to the objects provided in parameter add
changedat	system modification time of subscription object. If reset is true this parameter is not required, else the method fails if the input modification time does not match the last change time.
errorcount	the number of objects ignored to be added due to insufficient access

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCOWSSTDSERVICES@1.1001