JavaScript: Difference between revisions

Latest revision as of 12:07, 7 February 2025

Since version 7.20.10 SSP supports javascript steps in the workflow. Below is a summary of all SSP specific functions, available to be used within the step:

CommonInterface

The CommonInterface package supports a number of basic java functions that can be used in all javascript functions within SSP.

Common Functions

logToConsole (7.23.01)

logs entry to the JavaScript console

First parameter is the message or object to be added

CommonInterface.logToConsole('message');
returns: nothing

The logged information can be found on this url: https://yourserver/Common/Admin/JavaScriptConsole.aspx

logDebug

logs entry as 'debug' into the physical logfile of the Common application

First parameter is the message or object (since 7.22.10) to be added to the common log

CommonInterface.logDebug('message');
returns: nothing

logInfo (7.22.10)

logs entry as 'info' into the physical logfile of the Common application

First parameter is the message or object to be added to the common log

CommonInterface.logInfo('message');
returns: nothing

logWarning (7.22.10)

logs entry as 'warning' into the physical logfile of the Common application

First parameter is the message or object to be added to the common log

CommonInterface.logWarning('message');
returns: nothing

logError (7.22.10)

logs entry as 'error' into the physical logfile of the Common application

First parameter is the message or object to be added to the common log

CommonInterface.logError('message');
returns: nothing

logFatal (7.22.10)

logs entry as 'fatal' into the physical logfile of the Common application

First parameter is the message or object to be added to the common log

CommonInterface.logFatal('message');
returns: nothing

Get the hash of a string

first parameter is the type of hash, can be: sha1, sha1_base64, sha256, sha256_base64, sha512 or sha512_base64

second parameter is the string to be hashed

CommonInterface.getHash('sha512', 'test');
returns: EE26B0DD4AF7E749AA1A8EE3C10AE9923F618980772E473F8819A5D4940E0DB27AC185F8A0E1D5F84F88BC887FD67B143732C304CC5FA9AD8E6F57F50028A8FF

encrypts string

first parameter is the password (if empty the default one is used)
second parameter is the string to be encrypted

CommonInterface.encrypt('test', 'mypassword');
returns: oOe3y182qDKOGzmFpfTiLzNpML+fyvwhfjA9HqF9OwYqcM/PZovosALARZzApNnvToKpBV1dsWnaDP7+iTBo/ic33ZwcxuNRlbGHiKDwdEY=

decrypts string

first parameter is the password (if empty the default one is used)

CommonInterface.decrypt('oOe3y182qDKOGzmFpfTiLzNpML+fyvwhfjA9HqF9OwYqcM/PZovosALARZzApNnvToKpBV1dsWnaDP7+iTBo/ic33ZwcxuNRlbGHiKDwdEY=', 'mypassword');
returns: test

generate a new guid

CommonInterface.newGuid();
returns: a new guid (eg 9ec5d882-dcb7-408b-9638-c4f05045f18c)

sleep

first parameter is the amount of time (in milliseconds) the thread needs to be suspended

CommonInterface.sleep(1000);
returns: nothing

toDate (7.22.02)

first parameter is date in string in the format yyyyMMdd or yyyyMMddHHmmss or yyyyMMddHHmm (7.24.10) - input is sanitize, these characters will be removed: "-", "/", "T", ":", " " and ".0000000" (7.25.02)

CommonInterface.toDate("20220101");
returns: a date object in the local time zone

toUtcDate (7.22.02)

first parameter is date in string in the format yyyyMMdd or yyyyMMddHHmmss or yyyyMMddHHmm (7.24.10) - input is sanitize, these characters will be removed: "-", "/", "T", ":", " " and ".0000000" (7.25.02)

CommonInterface.toUtcDate("20220101");
returns: a date object in the UTC time zone

dateToString (7.22.02)

first parameter is date object in the local time zone (warning, dates created in Javascript are always UTC)
second parameter is the format you want the date to be in
optional third parameter is the culture (eg nl) since 7.24.10

CommonInterface.dateToString(new Date(2022, 0, 1), "yyyyMMdd");
returns: the date in string in the format specified -> 20211231

CommonInterface.dateToString(CommonInterface.toDate("20220101"), "yyyyMMdd");
returns: the date in string in the format specified -> 20220101

dateToUtcDate (7.23.04)

first parameter is date object

CommonInterface.dateToUtcDate(CommonInterface.toDate("20220101"));
returns: the date object in UTC

utcDateToDate (7.23.04)

first parameter is date object in UTC

CommonInterface.dateToUtcDate(new Date(2022, 0, 1));
returns: the date object

utcDateToString (7.22.02)

first parameter is date object in the UTC time zone (dates created in Javascript are always UTC)
second parameter is the format you want the date to be in
optional third parameter is the culture (eg nl) since 7.24.10

CommonInterface.utcDateToString(new Date(2022, 0, 1), "yyyyMMdd");
returns: the date in string in the format specified -> 20220101

stringToDate (7.22.06)

first parameter is the input string which represents the date
second parameter is the format the input is in

CommonInterface.stringToDate("20211231", "yyyyMMdd");
returns: the date object

stringToUtcDate (7.22.06)

first parameter is the input string which represents the date
second parameter is the format the input is in

CommonInterface.stringToUtcDate("20211231", "yyyyMMdd");
returns: the date object in UTC

dateAdd (7.22.09)

Manipulate a date

first parameter: date
second parameter: amount
third parameter: unit (bh, bd, y, year, M, month, d, day, h, hour, m, minute, s, second) bh = business hour, bd = business day, since 7.24.10: bm = business minute, bs = business second

CommonInterface.dateAdd(new Date(), -5, "h");
returns: the modified date (eg now minus 5 hours)

dateDiff (7.24.10)

Calculate the difference between tow dates

first parameter: date1
second parameter: date2
third parameter: unit (bh, bd, bm, bs, y, year, M, month, d, day, h, hour, m, minute, s, second) bh = business hour, bd = business day, bm = business minute, bs = business second

CommonInterface.dateDiff(date1, date2, "h");
returns: the difference (eg 5 hours)

getSspEnvironmentName (7.22.06)

Gets the SSP environment name as configured in the settings

CommonInterface.getSspEnvironmentName();
returns: the environment name (eg: Production)

getLanguages (7.22.06)

Gets all the languages available in the installation

CommonInterface.getLanguages();
returns: array of objects with properties id, name, flagurl, isdefault, and culture in JSON

getTranslationsByCategory (7.22.08)

Gets all the translations by categoryname

first parameter: category
optional second parameter languageid (default is current language id)

CommonInterface.getTranslationsByCategory("CustomUI");
returns: array of objects with name of the translation as propertyname and the translation as value JSON

getTranslationsLastReloadTicks (7.22.08)

Gets the date in ticks of the last reload time (use for client side caching of the translations)

CommonInterface.getTranslationsLastReloadTicks();
returns: the date in ticks

getDefaultLanguageCulture (7.23.08)

Gets the culture of the default language

CommonInterface.getDefaultLanguageCulture();
returns: the culture

getDefaultLanguageName (7.23.08)

Gets the name of the default language

CommonInterface.getDefaultLanguageName();
returns: the name

getDefaultLanguageId (7.23.08)

Gets the id of the default language

CommonInterface.getDefaultLanguageId();
returns: the id

getNewEventEntriesById (7.22.08)

Gets all the new event entries greater than the id specified

first parameter: id
optional second parameter: typename

CommonInterface.getNewEventEntriesById(0);
returns: array of objects with properties id, dateadded, typename and payload JSON

getNewEventEntriesByDate (7.22.08)

Gets all the new event entries greater than or equal to the date specified

first parameter: date
optional second parameter: typename

CommonInterface.getNewEventEntriesByDate("2022-08-01T14:00:00");
returns: array of objects with properties id, dateadded, typename and payload JSON

getCompanyName (7.24.02)

Returns the name of the company as specified in the license key

CommonInterface.getCompanyName();
returns: the company name

getClientVersion (7.25.01)

Returns the client version of the SSP installation

CommonInterface.getClientVersion();
returns: the client version

getTextPageDetail (7.24.07)

Gets a text page by name

first parameter: name

CommonInterface.getTextPageDetail('Help');
returns: object with properties id, name, title, content and documents (=array of objects with properties url and name) in JSON

Conversion

Convert text to base64

Converts a string into a base64 encoded string

First parameter is the string to be converted

CommonInterface.convertToBase64('test');
returns: dGVzdA==

Convert base64 to string

Converts a string that is base64 encoded into a readable string

first parameter is the string to be decoded

CommonInterface.convertFromBase64('dGVzdA==');
returns: test

json encode (7.21.09)

Encodes to JSON.

first parameter is the object to be encoded

CommonInterface.jsonEncode({ name: 'John' });
returns: {"name":"John"}

json decode (7.21.09)

Converts JSON into object

first parameter is the text to be converted

CommonInterface.jsonDecode('{"name":"John"}');
returns: the object

htmlencode text

Encodes text that contains html code into encoded html so that the html code is displayed in a browser. This function can be used to avoid the execution of input strings.

first parameter is the string to be encoded
optional second parameter whether line breaks show be replaces by br tags (defaults to true) (since 7.23.02)

CommonInterface.htmlEncode('test');
returns: <strong>test</strong>

line breaks to br tag (7.23.02)

Replaces the line breaks to br tags.

first parameter is the string to be used

CommonInterface.lineBreaksToBr('test1\ntest2');
returns: test1<br />test2

htmldecode text

Converts encoded html into default html

first parameter is the html string to be converted

CommonInterface.htmlDecode('<strong>test</strong>');
returns: test

urlencode text

Encodes a string into a url encoded string.

first parameter is the text to be encoded

CommonInterface.urlEncode('?param1=test1&param2=test2');
returns: %3fparam1%3dtest1%26param2%3dtest2

urldecode text

Decodes a url encoded string into a readable format

first parameter is the string to be decoded

CommonInterface.urlDecode('%3fparam1%3dtest1%26param2%3dtest2');
returns: ?param1=test1&param2=test2

xmlencode text

Encodes a text string into proper XML characters

first parameter is the string to be encoded

CommonInterface.xmlEncode('test1 & test2');
returns: test1 & test2

Remove invalid characters

first parameter is the string that contains non-standard characters

remove invalid (weird characters, mostly from pasting from other soures) xml characters:

CommonInterface.stripNonValidXMLCharacters ('♦≡╬▌test1'};
returns: test1

Convert bbcode to html

Convert bb-code in html formatted text, to include bb-code formatted text on web pages.

first parameter is the bbcode that should be converted into HTML
second optional parameter (since 7.24.11): object with possible key: Convert or Skip: array of types to convert or to skip (Bold, Italic, ...)

CommonInterface.bbCodeToHtml('[b]test[/b]');
returns: test

Convert bbcode to text

Convert bb-code into standard text by removing all codes

first parameter is the bbcode to be converted into text
second optional parameter (since 7.23.09): object with possible key: UseTextForLinks (value: true or false), when there's an url in the bb code, the label is used when UseTextForLinks is true - since 7.24.11: Convert or Skip: array of types to convert or to skip (Bold, Italic, ...)

CommonInterface.bbCodeToText('[b]test[/b]');
returns: test

Convert html to text (7.23.01)

Convert html into standard text by removing all codes

first parameter is the html to be converted into text

CommonInterface.convertHtmlToText('<strong>test</strong>');
returns: test

Strip html from text (7.23.01)

Remove html tags using a regular expression

first parameter is the html to be used

CommonInterface.stripHtml('<strong>test</strong>');
returns: test

Replace (7.22.09)

Returns a new string in which all occurrences of a specified string in the current string are replaced with another specified string

first parameter: the original string
second parameter: the string you wish to replace
third parameter: the string you to use as replacement

CommonInterface.replace('test', 't', 'b');
returns: besb

getValueFromXml (7.23.01)

Get a single value by an XPath expression from an XML string

first parameter: the XML as a string
second parameter: the XPath expression

CommonInterface.getValueFromXml('<?xml version="1.0" encoding="UTF-8"?><bookstore><book><title lang="en">Harry Potter</title><price>29.99</price></book><book><title lang="en">Learning XML</title><price>39.95</price></book></bookstore>', '/bookstore/book[1]/title/text()');
returns: Harry Potter

getValuesFromXml (7.23.01)

Get multiple values by an XPath expression from an XML string

first parameter: the XML as a string
second parameter: the XPath expression

CommonInterface.getValuesFromXml('<?xml version="1.0" encoding="UTF-8"?><bookstore><book><title lang="en">Harry Potter</title><price>29.99</price></book><book><title lang="en">Learning XML</title><price>39.95</price></book></bookstore>', '/bookstore/book/title/text()');
returns: ["Harry Potter","Learning XML"]

File System

Get the URL to SSP (7.23.01)

Get the pubic URL to ssp

CommonInterface.getSspUrl();
returns: 'https://demo.smt-x.com'

Get the local URL to SSP (7.23.01)

Get the pubic URL to ssp

CommonInterface.getSspLocalUrl();
returns: 'https//localhost'

Check if the input is a valid path (url or local path)

Checks if the provided path is valid. Returns 1 or 0

CommonInterface.isValidPath('D:\\test.txt');
CommonInterface.isValidPath('http://dev.ssp7.company.com/test.txt');
returns: boolean

Check if the url starts with the url (public or local) to ssp

CommonInterface.isSspFile('http://dev.ssp7.company.com/test.txt');
returns: boolean

Local path of url

returns local path to the file for a provided url (only in case the URL point to an ssp file)

CommonInterface.getLocalPathForSspFile('http://dev.ssp7.company.com/test.txt');
returns: C:\Websites\dev.ssp7.company.com\Sql.Dev.Ssp7\test.txt

Get the local root folder of the web application (7.24.12)

returns the local root folder of the web application

CommonInterface.getLocalPathToWebRoot();
returns: C:\Websites\dev.ssp7.company.com\Sql.Dev.Ssp7\

Get the filename of the url / local path

retrieves the file name that is part of a url

CommonInterface.getFileName('http://dev.ssp7.company.com/test.txt');
returns: test.txt

Get the file extension of the url / local path

Retrieves the extension of the file provided as argument

CommonInterface.getFileExtension('http://dev.ssp7.company.com/test.txt');
returns: .txt

Get the file content of the url / local path

Downloads the file provided as argument and returns the file contents

CommonInterface.getFileContent('http://dev.ssp7.company.com/test.txt');
returns: test content

Get the file content of the url / local path with encoding specified (since 7.21.11)

Downloads the file provided as argument and returns the file contents using the encoding specified. See this list for possible encodings: https://docs.microsoft.com/nl-nl/windows/win32/intl/code-page-identifiers

CommonInterface.getFileContentWithEncoding('D:\\test.txt', 'windows-1250');
returns: test content

Get the file content in base 64 of the url / local path

CommonInterface.getFileContentInBase64('http://dev.ssp7.company.com/test.txt');
returns: dGVzdCBjb250ZW50

Get the file content as byte array of the url / local path (since 7.23.04)

CommonInterface.getFileContentInBytes('http://dev.ssp7.company.com/test.txt');
returns: the array of bytes

Get the file size in bytes of the url / local path

CommonInterface.getFileSizeInBytes('http://dev.ssp7.company.com/test.txt');
returns: 12

Format file size in readable format (with B, KB, MB, GB or TB)

Converts the provided number of bytes into a readable file size

CommonInterface.formatFileSizeInBytes(5242880);
returns: 5 MB

Save an object / array of objects to an Excel file (since 7.21.11)

parameter 1: the object / array of objects you want to save
parameter 2: name of the sheet in Excel
parameter 3: the physical location of the Excel file, including filename and .xlsx extension

CommonInterface.saveToExcel([{"name": "first value", "summary": "first summary"},{"name": "second value", "summary": "second summary"}], "Sheet1", "C:\\Temp\\Example.xlsx");
returns: nothing when success, otherwise the error message

Save an object / array of objects to an Excel file and return as base64 (since 7.24.03)

parameter 1: the object / array of objects you want to save
parameter 2: name of the sheet in Excel

CommonInterface.generateExcelInBase64([{"name": "first value", "summary": "first summary"},{"name": "second value", "summary": "second summary"}], "Sheet1");
returns: the Excel file in base64

Convert Excel in base64 to JSON array (since 7.25.02)

parameter 1: the Excel file in base64
optional parameter 2: object with possible properties: WorksheetName, OnlyUseStringType (when true, all values will be in string)

CommonInterface.excelInBase64ToJson("excelinbase64");
returns: the JSON respresentation of the Excel file

Convert Excel as byte array to JSON array (since 7.25.02)

parameter 1: the Excel file as a byte array
optional parameter 2: object with possible properties: WorksheetName, OnlyUseStringType (when true, all values will be in string)

CommonInterface.excelAsByteArrayToJson([0,1,2]);
returns: the JSON respresentation of the Excel file

Convert Excel to JSON array (since 7.25.02)

parameter 1: the location to the Excel file
optional parameter 2: object with possible properties: WorksheetName, OnlyUseStringType (when true, all values will be in string)

CommonInterface.excelFileToJson("C:\\temp\\example.xlsx");
returns: the JSON respresentation of the Excel file

Get allowed upload extensions (since 7.24.10)

Get the list of allowed file extensions to upload

CommonInterface.getAllowedUploadFileExtensions();
returns: an array with the extensions

Execute an application (since 7.22.09)

parameter 1: the path of the application to execute
optional parameter 2: the parameters to pass to the application

CommonInterface.executeApplication("cmd.exe", "/c \"dir /B C:\\Temp\"");
returns: as JSON encoded string of an object with properties output, error and exitcode

Save text as file (since 7.23.04)

parameter 1: the path (local or UNC, folder and file name) to save to
parameter 2: the contents of the file
optional parameter 3: the encoding to use

CommonInterface.saveTextAsFile("C:\\temp\\test.txt", "test");
returns: nothing

Save base64 as file (since 7.23.04)

parameter 1: the path (local or UNC, folder and file name) to save to
parameter 2: the base64 contents of the file

CommonInterface.saveBase64AsFile("C:\\temp\\test.txt", "dGVzdA==");
returns: nothing

Save byte array as file (since 7.23.04)

parameter 1: the path (local or UNC, folder and file name) to save to
parameter 2: the byte array

CommonInterface.saveBytesAsFile("C:\\temp\\test.txt", [104,105]);
returns: nothing

Copy a file (since 7.23.04)

parameter 1: the path (local or UNC, folder and file name) to the source file
parameter 2: the path (local or UNC, folder and file name) to save to
optional parameter 3: whether to overwrite the file if it exists

CommonInterface.copyFile("C:\\temp\\test.txt", "C:\\temp\\test2.txt");
returns: nothing

Move a file (since 7.23.04)

parameter 1: the path (local or UNC, folder and file name) to the source file
parameter 2: the path (local or UNC, folder and file name) to move to

CommonInterface.moveFile("C:\\temp\\test.txt", "C:\\temp\\test2.txt");
returns: nothing

Delete a file (since 7.23.04)

parameter 1: the path (local or UNC, folder and file name) to the file

CommonInterface.deleteFile("C:\\temp\\test.txt");
returns: nothing

Check if a file exists (since 7.23.04)

parameter 1: the path (local or UNC, folder and file name) to the file

CommonInterface.fileExists("C:\\temp\\test.txt");
returns: true or false

Create a directory (since 7.23.04)

parameter 1: the path (local or UNC) to the folder

CommonInterface.createDirectory("C:\\temp");
returns: nothing

Delete a directory (since 7.24.11)

parameter 1: the path (local or UNC) to the directory
optional parameter 2: whether to delete recursive or not (WARNING: deletes folder and all contents when true) - defaults to false

CommonInterface.deleteDirectory("C:\\temp");
returns: nothing

Check if a directory exists (since 7.23.04)

parameter 1: the path (local or UNC, folder and file name) to the folder

CommonInterface.directoryExists("C:\\temp");
returns: true or false

Get the files in a directory (since 7.23.04)

parameter 1: the path (local or UNC, folder and file name) to the folder

CommonInterface.getFilesInDirectory("C:\\temp");
returns: array of file names (including the folder name)

Get the sub directories in a directory (since 7.23.04)

parameter 1: the path (local or UNC, folder and file name) to the folder

CommonInterface.getDirectoriesInDirectory("C:\\temp");
returns: array of sub directory names (including the folder name)

Calling Web Services

Get or send data to or from a webservice defined under adapters

first parameter: name of webservice
second parameter: object with key / value that is used as input fields)
optional third parameter (7.23.01): object with key / value that is used as context (possible fields: name, processinstanceid, supportsretry, maxretrycount, currentretrycount, nocache, payload, istest)

changes since 7.22.10: in case the web service is not found, an error is thrown instead of returning an empty string

CommonInterface.callWebservice('Name of webservice', { 'field1': 'value1', 'field2': 'value2' });
returns in case of the webservice having a return type of single value: the single value (string)
returns in case of the webservice having a return type of datatable or valuelist: the object encoded as a JSON string. If you want to consume it as an object in your javascript, you must use 
JSON.parse(), eg in one line: JSON.parse(CommonInterface.callWebservice('Name of webservice', { 'field1': 'value1', 'field2': 'value2' }));

Get or send data to or from a webservice defined under adapters wrapped in result object (7.23.01)

Returns the result wrapped in an object with properties result, fromcache, success, doretry, doretrynow, message, exception, data and currentretrycount

first parameter: name of webservice
second parameter: object with key / value that is used as input fields)
optional third parameter: object with key / value that is used as context (possible fields: name, processinstanceid, supportsretry, maxretrycount, currentretrycount, nocache, payload, istest)

CommonInterface.callWebserviceWrapped('Name of webservice', { 'field1': 'value1', 'field2': 'value2' });

Schedule an SSP task to run on the next SSP Scheduler run (7.23.07)

first parameter: name of task

CommonInterface.scheduleTaskToRunOnNextSchedulerRun('Import Persons');

Datastore parameters

check if user has access to datastore parameter

First parameter: name of the parameter

CommonInterface.loggedInPersonCanManageParameterEntries('Address Book');
returns: boolean TRUE or FALSE if the currently logged in person has access to the parameter name provided

reload a datastore parameter from the source (since 7.23.07)

First parameter: name of the parameter

CommonInterface.reloadParameter('My external parameter');
returns: nothing

get all entries of a parameter

First parameter: name of the parameter

CommonInterface.getAllParameterEntries('Address Book');
returns: all the entries (array) with all the fields (properties) as JSON encoded string. If you want to consume it, use JSON.parse, eg: JSON.parse(CommonInterface.getAllParameterEntries('Address Book'));

get all entries of a parameter sorted on a field

First parameter: name of the parameter
second parameter: field to sort on

CommonInterface.getAllParameterEntriesAndSort('Address Book', 'Name');
returns: same as above but sorted via the query

Get the count of all entries of a parameter

first parameter: name of the parameter

CommonInterface.getAllParameterEntryCount('Address Book');
returns: 9

Get specific value of a field for a specific entry

first parameter: name of the parameter
second parameter: key field
third parameter: key value
fourth parameter: fields to return, joined by double pipes

CommonInterface.getParameterEntryValue('Address Book', 'Email', 'john@company.com', 'Name||Location');
returns: the values if the requested fields for the first entry found, joined by double pipe, eg: john Doe||Maastricht

Get all values of a field in a parameter

first parameter: name of the parameter
second parameter: field name

CommonInterface.getParameterEntryValues('Address Book', 'Email');
returns: JSON encoded string of all the values (sorted), again to consume use JSON.parse, result: ["dasy@company.com","donald@company.com","john@company.com","example@gmail.com"]

Get parameter entries

first parameter: name of the parameter
second parameter: object with key / value containing the filter

CommonInterface.getParameterEntries('Address Book', { Email: 'john@smt-x.com' });
returns: see CommonInterface.getAllParameterEntries

Get parameter entries and sort

first parameter: name of the parameter
second parameter: object with key / value containing the filter
third parameter: name of the field to sort on

CommonInterface.getParameterEntriesAndSort('Address Book', { Email: 'john@smt-x.com' }, 'Name');
returns: see CommonInterface.getAllParameterEntries

Advanced search on parameter entries

first parameter: name of the parameter
second parameter: array of objects containing the predicates

CommonInterface.searchParameterEntries('Address Book', [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'gmail.com' },{ connector: 'or', subfilter: [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'company' }, { fieldname: 'Email', filteroperator: 'notcontains', filtervalue: 'john' } ]}]);
returns: see CommonInterface.getAllParameterEntries

for all filter operators see here

Advanced search and sort on parameter entries

first parameter: name of the parameter
second parameter: object with key / value containing the predicates
third parameter: field to sort on

CommonInterface.searchParameterEntriesAndSort('Address Book', [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'gmail.com' },{ connector: 'or', subfilter: [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'company' }, { fieldname: 'Email', filteroperator: 'notcontains', filtervalue: 'john' } ]}], 'Location');
returns: same as CommonInterface.searchParameterEntries but sorted via the query

Get the result count of an advanced search

first parameter: name of the parameter
second parameter: object with key / value containing the predicates

CommonInterface.searchParameterEntryCount('Address Book', [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'gmail.com' },{ connector: 'or', subfilter: [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'company' }, { fieldname: 'Email', filteroperator: 'notcontains', filtervalue: 'john' } ]}]);
returns:  the number of records found

Add an entry to a parameter

first parameter: name of the parameter
second parameter: object with key / value that contains the fields (keys) with the values (values)

CommonInterface.addParameterEntry('Address Book', { 'Name': 'Test', 'Email': 'test@company.com' });
returns:  the new internal id of the entry
Example: 
var field1 = #REPLACE-FORMFIELD-ABC#;
var field2 = #REPLACE-FORMFIELD-DEF#;
CommonInterface.addParameterEntry('Address Book', { 
   columnname1 : field1, 
   columnname2 : field2 
});

Add an entry to a parameter SECURE

first parameter: name of the parameter
second parameter: object with key / value that contains the fields (keys) with the values (values)
security: This function checks if the currently logged in person is authorized to edit the parameter

CommonInterface.addParameterEntrySecure('Address Book', { 'Name': 'Test', 'Email': 'test@company.com' });
returns:  the new internal id of the entry

Add multiple entries to a parameter (since 7.23.07)

first parameter: name of the parameter
second parameter: array of objects with key / value that contains the fields (keys) with the values (values)

CommonInterface.addParameterEntries('Address Book', [{ 'Name': 'Test1', 'Email': 'test1@company.com' }, { 'Name': 'Test2', 'Email': 'test2@company.com' }]);
returns:  array of the new internal ids for the entries

Add multiple entries to a parameter SECURE (since 7.23.07)

first parameter: name of the parameter
second parameter: array of objects with key / value that contains the fields (keys) with the values (values)
security: This function checks if the currently logged in person is authorized to edit the parameter

CommonInterface.addParameterEntriesSecure('Address Book', [{ 'Name': 'Test1', 'Email': 'test1@company.com' }, { 'Name': 'Test2', 'Email': 'test2@company.com' }]);
returns:  array of the new internal ids for the entries

updates zero or more parameter entries

first parameter: name of the parameter
second parameter: object with key / value that represents the predicate (filter)
third parameter: object with key / value that contains the new values (not all values are required)

CommonInterface.updateParameterEntries('Address Book', { 'Email': 'test@company.com' }, { 'Name': 'Test updated' });
returns:  the number of entries updated (make sure you use the correct filter, you could potentially update all the entries)

updates zero or more parameter entries SECURE

first parameter: name of the parameter
second parameter: object with key / value that represents the predicate (filter)
third parameter: object with key / value that contains the new values (not all values are required)
Security: This function checks if the currently logged in person is authorized to edit the parameter

CommonInterface.updateParameterEntriesSecure('Address Book', { 'Email': 'test@company.com' }, { 'Name': 'Test updated' });
returns:  the number of entries updated (make sure you use the correct filter, you could potentially update all the entries)

Delete zero or more parameter entries

first parameter: name of the parameter
second parameter: object with key / value that represents the predicate (filter)

CommonInterface.deleteParameterEntries('Address Book', { 'Email': 'test@company.com' });
returns:  the number of entries deleted (make sure you use the correct filter, you could potentially delete all the entries)

Delete zero or more parameter entries SECURE

first parameter: name of the parameter
second parameter: object with key / value that represents the predicate (filter)
Security: This function checks if the currently logged in person is authorized to edit the parameter

CommonInterface.deleteParameterEntriesSecure('Address Book', { 'Email': 'test@company.com' });
returns:  the number of entries deleted (make sure you use the correct filter, you could potentially delete all the entries)

Delete all parameter entries (since 7.23.07)

first parameter: name of the parameter

CommonInterface.deleteAllParameterEntries('Address Book');
returns:  the number of entries deleted

Delete all parameter entries SECURE (since 7.23.07)

first parameter: name of the parameter
Security: This function checks if the currently logged in person is authorized to edit the parameter

CommonInterface.deleteAllParameterEntriesSecure('Address Book');
returns:  the number of entries deleted

Person and person group (7.21.07)

getPerson

Get person with internal id

First parameter is internal id of the person

CommonInterface.getPerson(1);
returns: object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

getPersons (7.23.08)

Get persons with internal id

First parameter is an array with internal id of the persons

CommonInterface.getPersons([1,2]);
returns: array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

getPersonsByEmail (acted as searchPersonsByEmail before 7.22.02)

Get list of people via email

First parameter is the email address

CommonInterface.getPersonsByEmail("john@doe.com");
returns: array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

getActivePersonByEmail (7.22.02)

Get active peron via email

First parameter is the email address

CommonInterface.getActivePersonByEmail("john@doe.com");
returns: object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

searchPersonsByEmail (7.22.02)

Get list of people by searching via email

First parameter is the email address

CommonInterface.searchPersonsByEmail("@doe.com");
returns: array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

getPersonsByUniqueId (acted as searchPersonsByUniqueId before 7.22.02)

Get list of people via uniqueid

First parameter is the uniqueid

CommonInterface.getPersonsByUniqueId("john.doe");
returns: array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

getActivePersonByUniqueId (7.22.02)

Get person via uniqueid

First parameter is the uniqueid

CommonInterface.getActivePersonByUniqueId("john.doe");
returns: object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

searchPersonsByUniqueId (7.22.02)

Get list of people by searching via uniqueid

First parameter is the uniqueid

CommonInterface.searchPersonsByUniqueId("jo");
returns: array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

getPersonsByFilter (7.24.11)

Search for persons using a filter

first parameter: a filter object or an array of filter objects
optional second parameter: an object with paging information

CommonInterface.getPersonsByFilter([{IsActive: true}, { Connector: "OR", FieldName: "Email", FilterValue: "smt-x.com", Operator: "EndsWith" }]);
returns: array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

reloadPersonData (7.23.07)

Reloads the persons data

First parameter is the id of the person

CommonInterface.reloadPersonData(1);
returns: nothing

getPersonDetail (7.23.07)

Gets the detail of a person, including the person extra fields

First parameter is the id of the person
Optional second parameter is a boolean whether to reload the persons data first

CommonInterface.getPersonDetail(1, true);
returns: object with properties id, firstname, lastname, email, uniqueid, description, inactive, fields (array of objects with properties name and value) in JSON

getPersonField

Get the value of a person field for a specific person

First parameter is the internal id of the person
Second parameter is the name of the field (can be UniqueId, FirstName, LastName, Email or any other custom defined person field)

CommonInterface.getPersonField(1, "Country");
returns: the value of the field

getPersonFirstAndLastName

Get the first and last name of a person

First parameter is the internal id of the person

CommonInterface.getPersonFirstAndLastName(1);
returns: the first and last name

getPersonDescription

Get the description of a person

First parameter is the internal id of the person

CommonInterface.getPersonDescription(1);
returns: the description in the format as defined in the settings

getPersonGroupsForPerson

Get the person groups where the person is member of (before 7.24.05: only active ones + where person is member or manager)

First parameter is the internal id of the person

CommonInterface.getPersonGroupsForPerson(1);
returns: array of objects with properties id, name, description, inactive (7.24.05) in JSON

getPersonGroupsAsManagerForPerson (7.24.05)

Get the person groups where the person is manager of

First parameter is the internal id of the person

CommonInterface.getPersonGroupsAsManagerForPerson(1);
returns: array of objects with properties id, name, description, inactive (7.24.05) in JSON

getPersonGroupsAsManagerOrMemberForPerson (7.24.05)

Get the person groups where the person is manager or member of

First parameter is the internal id of the person

CommonInterface.getPersonGroupsAsManagerOrMemberForPerson(1);
returns: array of objects with properties id, name, description, inactive (7.24.05) in JSON

getPersonGroup

Get the person group with internal id

First parameter is the internal id of the person group

CommonInterface.getPersonGroup(1);
returns: object with properties id, name and description in JSON

getPersonGroupsByName

Get a list of person groups via name

First parameter is the name

CommonInterface.getPersonGroupsByName("Groupname");
returns: array of objects with properties id, name and description in JSON

getPersonGroupsByFilter (7.24.11)

Search for person groups using a filter

first parameter: a filter object or an array of filter objects
optional second parameter: an object with paging information

CommonInterface.getPersonGroupsByFilter([{IsActive: true}, { Connector: "OR", FieldName: "Name", FilterValue: "test", Operator: "Contains" }]);
returns: array of objects with properties id, name, description and inactive in JSON

addPersonToPersonGroup (7.23.03)

Adds a person to a person group

first parameter is the internal id of the person group
second parameter is the internal id of the person
optional third parameter is whether the person wants to receive the mails via the group

CommonInterface.addPersonToPersonGroup(1, 1);
returns: true if there were changes, false otherwise

setPersonsInPersonGroup (7.23.03)

Sets the list of persons in a person group

first parameter is the internal id of the person group
second parameter is an array with internal ids of the persons
optional third parameter is whether the persons want to receive the mails via the group

CommonInterface.setPersonsInPersonGroup(1, [1, 2, 3], false);
returns: true if there were changes, false otherwise

removePersonFromPersonGroup (7.23.03)

Removes a person from a person group

first parameter is the internal id of the person group
second parameter is the internal id of the person

CommonInterface.removePersonFromPersonGroup(1, 1);
returns: true if there were changes, false otherwise

getPersonsForPersonGroup

Get the members of the person group

First parameter is the internal id of the person group

CommonInterface.getPersonsForPersonGroup(1);
returns: array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

searchPersons (7.22.06)

Search for people

first parameter is text you wish to search for
optional second parameter is the number of records you'd like to receive (default is 50)

CommonInterface.searchPersons("john");
returns: array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

Global messages (7.22.06)

getGlobalMessages

Get the active global messages

CommonInterface.getGlobalMessages();
returns: array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON

getGlobalMessages SECURE (7.22.12)

Get the active global messages for the logged in user

CommonInterface.getGlobalMessagesSecure();
returns: array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON

getGlobalMessages expired (7.22.12)

Get the expired global messages

CommonInterface.getExpiredGlobalMessages();
returns: array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON

getGlobalMessages expired SECURE (7.22.12)

Get the expired global messages for the logged in user

CommonInterface.getExpiredGlobalMessagesSecure();
returns: array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON

markGlobalMessageAsSeen

Marks a global message as seen for the logged in account

first parameter is the id of the message

CommonInterface.markGlobalMessageAsSeen(1);
returns: nothing

Navigation items (7.22.10)

Get navigation items

Get all the navigation items

CommonInterface.getNavigationItems();
returns: array of object with properties id, name, typeid, typename, url, showinbox, showatbottom and boxcssclass in JSON

Get navigation items SECURE

Get all the navigation items based on the logged in user

CommonInterface.getNavigationItemsSecure();
returns: array of object with properties id, name, typeid, typename, url, showinbox, showatbottom and boxcssclass in JSON

WorkflowInterface

The WorkflowInterface contains function that interact with tickets

Processes

Search count processes (7.23.08)

Returns the number of processes that matches the criteria

first parameter: object with possible properties: isretired, text, name, nameoperator
optional second parameter: object with possible property: languageid

WorkflowInterface.searchCountProcesses({ name: "phone", nameoperator: "contains" });
returns: the number

Search count processes SECURE (7.23.08)

Returns the number of processes that matches the criteria

first parameter: object with possible properties: isretired, text, name, nameoperator
optional second parameter: object with possible property: languageid

WorkflowInterface.searchCountProcessesSecure({ internallabel: "phone", internallabeloperator: "contains" });
returns: the number

Search processes (7.23.08)

Returns the processes that matches the criteria

first parameter: object with possible properties: isretired, text, name, nameoperator
optional second parameter: object with possible properties: languageid, itemsperpage, pageindex

WorkflowInterface.searchProcesses({ internallabel: "phone", internallabeloperator: "contains" });
returns: array of objects with properties id, title, description in JSON

Search processes SECURE (7.23.08)

Returns the processes that matches the criteria

first parameter: object with possible properties: isretired, text, name, nameoperator
optional second parameter: object with possible properties: languageid, itemsperpage, pageindex

WorkflowInterface.searchProcessesSecure({ internallabel: "phone", internallabeloperator: "contains" });
returns: array of objects with properties id, title, description in JSON

General

Check if a ticket id exists (7.21.07)

first parameter: ticket id

WorkflowInterface.processInstanceIdExists(1500);
returns: true or false

Remove process instance object from thread cache (7.21.07)

For performance reasons, the process instance object will be cached per request, if you edit the object and request data after the action you may need to clear the cache first. Use this only when you are sure you need this.

first parameter: ticket id

WorkflowInterface.removeProcessInstanceFromThreadCache(1500);
returns: nothing

Check if process instance is still submitting (7.22.07)

first parameter: ticket id

WorkflowInterface.processInstanceIsStillSubmitting(1500);
returns: true or false

Check if process instance is closed (7.22.09)

first parameter: ticket id

WorkflowInterface.processInstanceIsClosed(1500);
returns: true or false

Evaluate replace placeholders (7.22.07)

Evaluates the replace placeholders in the specified text

first parameter: ticket id
second parameter: the text containing the replace placeholders
optional third parameter: object with optional properties IsInHtml, UseLoggedInAccount, UseCurrentLanguage, LanguageId

WorkflowInterface.evaluateReplacePlaceholders(1500, "#REPLACE-STEP-PROCESS-Guid#");
returns: the evaluated value

Do check wait steps (7.22.09)

Evaluates the open wait steps in a ticket

first parameter: ticket id

WorkflowInterface.doCheckWaitSteps(1500);
returns: nothing (this executes in a separate thread, so it does not wait until the wait step checks are done)

Do resume from here (7.23.01)

Restarts a process instance from a certain step

first parameter: ticket id
second parameter: processinstancestepid
third parameter: actor name
forth parameter: whether to remove the previous instances

WorkflowInterface.doResumeFromProcessInstanceStep(1500, 1800, "SYSTEM", false);
returns: nothing (this executes in a separate thread)

Do retry from here (7.23.01)

Retries a process instance step (in case it can be retried)

first parameter: ticket id
second parameter: instance step id
third parameter: actor name

WorkflowInterface.doRetryProcessInstanceStep(1500, 1800, "SYSTEM");
returns: nothing (this executes in a separate thread)

Stop process instance (7.24.10)

Stops a process instance without checking the rights

first parameter: ticket id
optional second parameter: the actor name
optional third parameter: the actor person id

WorkflowInterface.stopProcessInstance(1500);
returns: nothing

Stop process instance secure (7.24.10)

Stops a process instance if the logged in person has the rights to do this

first parameter: ticket id
optional second parameter: the actor name
optional third parameter: the actor person id

WorkflowInterface.stopProcessInstanceSecure(1500);
returns: nothing

Get workflow information for a ticket (7.21.07)

first parameter: ticket id

WorkflowInterface.getWorkflowInformation(1500);
returns: object with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), formid, forminstanceid, externalappname, name, processname, formname, isarchived and pool (object with properties id and name) and ticketnr (7.22.06 - contains customkey) in JSON

Search workflow tickets count (7.22.06)

Returns the number of tickets based on the search criteria without checking the current logged in user

first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)

WorkflowInterface.searchCountWorkflowTickets({"Status": "Open"});
returns: nr of tickets

Search workflow tickets count SECURE (7.22.06)

Returns the number of tickets based on the search criteria where the logged in user has rights for

first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)

WorkflowInterface.searchCountWorkflowTicketsSecure({"Status": "Open"});
returns: nr of tickets

Search workflow tickets (7.22.06)

Returns the tickets based on the search criteria without checking the current logged in user

first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)
optional second parameter: object with paging info (properties: ItemsPerPage, PageIndex) - default is 10 records

WorkflowInterface.searchWorkflowTickets({"Status": "Open"});
returns: array of objects with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), formid, forminstanceid, externalappname, name, processname, formname, isarchived and pool (object with properties id and name) and ticketnr (7.22.06 - contains customkey) in JSON

Search workflow tickets SECURE (7.22.06)

Returns the tickets based on the search criteria where the logged in user has rights for

first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)
optional second parameter: object with paging info (properties: ItemsPerPage, PageIndex) - default is 10 records

WorkflowInterface.searchWorkflowTicketsSecure({"Status": "Open"});
returns: array of object with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), formid, forminstanceid, externalappname, name, processname, formname, isarchived and pool (object with properties id and name) and ticketnr (7.22.06 - contains customkey) in JSON

Get ticketing information for a ticket (7.21.07)

first parameter: ticket id

WorkflowInterface.getTicketInformation(1500);
returns: object with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), islocked, isrunning, tickettype, tasktype, requestedforteam, pool (object with properties id and name), medium (object with properties code and name), priority (object with properties code and name), status (object with properties code and name), service (object with properties code and name), category (object with properties code and name), classification (object with properties code and name), closurecode (object with properties code and name), description, information, solution, solutionlinkalldocuments, solutiondocumentkeys (array of keys in string), plannedeliverydate, deadlinedate, requestedforalternatename, requestedforalternateemail, requestedforalternatetelephone, assignedtoperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtopersongroup (object with properties id, name and description), customfields (array of objects with properties name, typeid, typename, ishidden, parametername, parametervaluefield, parameterdisplayfield, stringvalue and datetimevalue) in JSON

Start a new process instance (7.21.12)

first parameter: process (id or name)
second parameter: requestor person (id or unique id or email) (can be null since 7.24.03)
third parameter: requested for person (id or unique id or email) (can be null since 7.24.03)
fourth parameter: external app name
fifth parameter: array of form field objects, each object can have the properties displayvalue, value, internallabel, label and labels (array of objects with properties label and language)

WorkflowInterface.startProcessInstance("My test process", "John.Doe", "John.Doe", "my test app", [{ internallabel: "field1", value: "value 1", labels: [{ label: "field 1", language: "English" }, { label: "veld 1", language: "Nederlands" }] }, { value: "value 2", displayvalue: "dis val 2", label: "field 2" }]);
returns: object with properties id and guid in JSON

Start a new process instance with passing thru initial ticketing data (7.21.12)

first parameter: process (id or name)
second parameter: requestor person (id or unique id or email) (can be null since 7.24.03)
third parameter: requested for person (id or unique id or email) (can be null since 7.24.03)
fourth parameter: external app name
fifth parameter: array of form field objects, each object can have the properties displayvalue, value (or rawvalue 7.23.07), internallabel (or internalname 7.23.07), label and labels (array of objects with properties label and language)
sixth parameter: object with initial ticketing data, possible properties are assignedtoperson, assignedtopersongroup, category, classification, closurecode, deadlinedate, description, information, initialtasksfield, medium, planneddeliverydate, pool, priority, requestedfor, requestedforalternateemail, requestedforalternatename, requestedforalternatetelephone, requestedforteam, service, solution, status and customfields (array of objects with properties fieldname and stringvalue)

WorkflowInterface.startProcessInstanceWithTicketData("My test process", "John.Doe", "John.Doe", "my test app", [{ internallabel: "field1", value: "value 1", labels: [{ label: "field 1", language: "English" }, { label: "veld 1", language: "Nederlands" }] }, { value: "value 2", displayvalue: "dis val 2", label: "field 2" }], { status: "New", assignedtopersongroup: "My first group", assignedtoperson: "John.Doe", "Description": "test", customfields: [{fieldname: "customfield1", stringvalue: "custom field value"}] });
returns: object with properties id and guid in JSON

Rights (7.21.07)

Check if the logged in person has workflow admin rights on the ticket

first parameter: ticket id

WorkflowInterface.loggedInPersonHasWorkflowAdminRight(1500);
returns: true or false

Check if the logged in person has workflow power user rights on the ticket

first parameter: ticket id

WorkflowInterface.loggedInPersonHasWorkflowPowerUserRight(1500);
returns: true or false

Check if the logged in person has workflow read rights on the ticket

first parameter: ticket id

WorkflowInterface.loggedInPersonHasWorkflowReadRight(1500);
returns: true or false

Check if the logged in person has workflow write rights on the ticket

first parameter: ticket id

WorkflowInterface.loggedInPersonHasWorkflowWriteRight(1500);
returns: true or false

Check if the logged in person has ticketing limited rights on the ticket

first parameter: ticket id

WorkflowInterface.loggedInPersonHasTicketLimitedRight(1500);
returns: true or false

Check if the logged in person has ticketing read rights on the ticket

first parameter: ticket id

WorkflowInterface.loggedInPersonHasTicketReadRight(1500);
returns: true or false

Check if the logged in person has ticketing write rights on the ticket

first parameter: ticket id

WorkflowInterface.loggedInPersonHasTicketWriteRight(1500);
returns: true or false

Check if the logged in person has write rights on the task (no checks on ticket are done)

first parameter: task id

WorkflowInterface.loggedInPersonHasTaskWriteRight(100);
returns: true or false

Variables

Get the value of a variable in a ticket

first parameter: ticket id
second parameter: name of the variable

WorkflowInterface.getVariableValue(1500, 'My variable');
returns: the value as string

sets the value of a variable in a ticket (if it doesn't exists, it will be created)

first parameter: ticket id
second parameter: name of the variable
third parameter: value of the variable

WorkflowInterface.setVariableValue(1500, 'My variable', 'new value');
returns: nothing

Form Values

Get all form fields for a ticket (7.21.07)

first parameter: ticket id

WorkflowInterface.getAllFormFields(1500);
returns: array of objects with properties fieldorder, fieldtypeid, fieldtypename, internalname, label, helptext, subfielddefinition, parametername, value (object depending on the fieldtype), rawvalue, displayvalue, visible, htmlencode, repeatablesectionindex, repeatablesectionfieldid, visibleforui (since 7.23.10) in JSON

Get raw value of a form field in a ticket

first parameter: ticket id
second parameter: internal name of the form field

WorkflowInterface.getFormFieldValue(1500, 'MyFormField');
returns: the value as string

Get raw displayvalue of a form field in a ticket

first parameter: ticket id
second parameter: internal name of the form field

WorkflowInterface.getFormFieldDisplayValue(1500, 'MyFormField');
returns: the display value as string

Get the value definition of a form field in a ticket (for selection fields)

first parameter: ticket id
second parameter: internal name of the form field

WorkflowInterface.getFormFieldSubFieldDefinition(1500, 'MyFormField');
returns: the definition (eg: Name||Email)

Get the sub value of a form field in a ticket (for selection fields)

first parameter: ticket id
second parameter: internal name of the form field
third parameter: name of the sub field

WorkflowInterface.getFormSubFieldValue(1500, 'MyFormField', 'Name');
returns: the value as string (eg: Raymond)

Get the list of sub value of a form field in a ticket (for selection fields with multiple values)

first parameter: ticket id
second parameter: internal name of the form field
third parameter: name of the sub field

WorkflowInterface.getFormSubFieldValues(1500, 'MyFormField', 'Name');
returns: the values as string array in JSON (eg: ["Dominic", "Raymond"])

Get an object (key/value) where key is the sub field name and value the selected values of a form field in a ticket (for selection fields with single value)

first parameter: ticket id
second parameter: internal name of the form field

WorkflowInterface.getFormFieldSelectionValue(1500, 'MyFormField');
returns: object in JSON (eg: {"Name": "Raymond", "Email": "raymond@smt-x.com"})

Get a list of objects (key/value) where key is the sub field name and value the selected values of a form field in a ticket (for selection fields with multiple values)

first parameter: ticket id
second parameter: internal name of the form field

WorkflowInterface.getFormFieldSelectionValues(1500, 'MyFormField');
returns: array of objects in JSON (eg: [{"Name": "Raymond", "Email": "raymond@smt-x.com"},{"Name": "Dominic", "Email": "dominic@smt-x.com"}])

Open actions

Get the open (step) actions in a ticket

first parameter: ticket id

WorkflowInterface.getOpenActions(1500);
returns: array of open actions in JSON (properties: stepname, stepinformation, link, array of actors (person), messagesfunctionid, allowsubmit, typeid, pisiaid, pisianame, submithash, array of fields (properties: id, name, typeid, required, stringvalue, displaystringvalue, datetimevalue, pdbname, pdbvaluefieldname, pdbtextfieldname, pdbhashcheck, rows, regex, helptext), haswriterights (since 7.23.10))

Get the amount of open actions for the logged in user (7.24.07)

WorkflowInterface.getMyOpenActionsCountSecure();
returns: the amount of open actions for the logged in user

Get the amount of open actions for a specific email address (7.24.07)

first parameter: email

WorkflowInterface.getOpenActionsByEmailCount(email);
returns: the amount of open actions for the email address

Get the open actions for the logged in user (7.24.07)

WorkflowInterface.getMyOpenActionsSecure();
returns: an array of objects with properties processinstanceid, processinstanceguid, processinstancestepid, processinstancestepactorid, processinstancestepinstanceactorinstanceid, datestarted, stepname, link, processinstancename, processinstancedatestarted, processinstancerequestorperson, processinstancerequestedforperson in JSON

Get the open actions for a specific email address (7.24.07)

first parameter: email

WorkflowInterface.getOpenActionsByEmail(email);
returns: an array of objects with properties processinstanceid, processinstanceguid, processinstancestepid, processinstancestepactorid, processinstancestepinstanceactorinstanceid, datestarted, stepname, link, processinstancename, processinstancedatestarted, processinstancerequestorperson, processinstancerequestedforperson in JSON

Steps (since 7.24.10)

Get all steps as tree in a ticket

first parameter: ticket id

WorkflowInterface.getSteps(1500);
returns: array of objects in JSON

Get all steps as tree in a ticket secure

Get all steps as tree in a ticket visible for the logged in person

first parameter: ticket id

WorkflowInterface.getStepsSecure(1500);
returns: array of objects in JSON

Get all steps as list in a ticket (since 7.25.02)

Get all steps as list in a ticket

first parameter: ticket id

WorkflowInterface.getStepsAsList(1500);
returns: array of objects in JSON

Get all steps as list in a ticket secure (since 7.25.02)

Get all steps as list in a ticket visible for the logged in person

first parameter: ticket id

WorkflowInterface.getStepsAsListSecure(1500);
returns: array of objects in JSON

Additional information (since 7.24.11)

Submit the answer for an additional information request

Submits the answer without checking the logged in user

first parameter: id
second parameter: answer

WorkflowInterface.submitAdditionalInformationAnswer(150, 'answer');
returns: true if succesful, false if it was already answered, null if not found or no rights

Submit the answer for an additional information request secure

Submits the answer only if the logged in user is allowed to

first parameter: id
second parameter: answer

WorkflowInterface.submitAdditionalInformationAnswerSecure(150, 'answer');
returns: true if succesful, false if it was already answered, null if not found or no rights

Logging

Get all logs for a ticket (7.21.07)

Get a list with all logs, including workflow logs, private notes, public messages and ticket changes

first parameter: ticket id

WorkflowInterface.getAllLogs(1500);
returns: array of objects with properties date, person (object with properties id, firstname, lastname, email, uniqueid, description and inactive), text, typeid, typename, notified (array of names), documentkeys (array of keys in string) in JSON

Get workflow logs for a ticket (7.21.07)

Get a list of only workflow logs

first parameter: ticket id

WorkflowInterface.getWorkflowLogs(1500);
returns: array of objects with properties date, person (object with properties id, firstname, lastname, email, uniqueid, description and inactive), text, typeid, typename, notified (array of names), documentkeys (array of keys in string) in JSON

Add a log to the process instance (workflow log)

first parameter: ticket id
second parameter: the log text

WorkflowInterface.addWorkflowLog(1500, 'My log text');
returns: nothing

Attachments

Get all documents for a ticket (7.21.07)

first parameter: ticket id

WorkflowInterface.getDocuments(1500);
returns: array of objects with properties type, url, name, isticketdocument, isvisible, id, key and date in JSON

Use 'key' as unique identifier, this key is also used in other objects (eg in solutiondocumentkeys)

Add document to a ticket

first parameter: TicketId
second parameter: Path to the file that should be added
third parameter: boolean (1 or 0) if file should be visible in workflow

WorkflowInterface.addDocument(ticketid, 'pathtofile', hideinworkflow);
returns: since 7.24.11: the document key

Add document to a ticket with a specific name

first parameter: TicketId
second parameter: Path to the file that should be added
third parameter: filename to show in workflow
fourth parameter: boolean (1 or 0) if file should be visible in workflow

WorkflowInterface.addDocumentWithFileName(ticketid, 'pathtofile', 'filenametoshow', hideinworkflow);
returns: since 7.24.11: the document key

Add document as base64 to a ticket (7.25.01)

first parameter: ticketid
second parameter: file in base64
third parameter: filename
fourth parameter: boolean (1 or 0) if file should be visible in workflow

WorkflowInterface.addDocumentInBase64(ticketid, 'dGVzdA==', 'test.txt', hideinworkflow);
returns: the document key

Delete all currently linked documents from a ticket

first parameter: TicketId

WorkflowInterface.deleteAllDocuments(ticketid);

Update Ticketing fields

Get action logs for a ticket (7.21.07)

Get a list of only action logs, that's pubic messages, private notes and ticket changes

first parameter: ticket id

WorkflowInterface.getActionLogs(1500);
returns: array of objects with properties date, person (object with properties id, firstname, lastname, email, uniqueid, description and inactive), text, typeid, typename, notified (array of names), documentkeys (array of keys in string) in JSON

Get action logs secure for a ticket (7.24.10)

Get a list of only action logs, that's pubic messages, private notes and ticket changes only if the logged in user is allowed to see them

first parameter: ticket id

WorkflowInterface.getActionLogsSecure(1500);
returns: array of objects with properties date, person (object with properties id, firstname, lastname, email, uniqueid, description and inactive), text, typeid, typename, notified (array of names), documentkeys (array of keys in string) in JSON

Add a public note within ticketing

first parameter: TicketId
second parameter: Person unique id or email address
third parameter: text to add as public note
optional fourth parameter: array of objects with properties filename and filecontentinbase64 (7.24.10)

WorkflowInterface.addPrivateNote(ticketid, personidoremail, logtext);

Add a private message within ticketing

first parameter: TicketId
second parameter: Person unique id or email address
third parameter: text to add as private note
optional fourth parameter: array of objects with properties filename and filecontentinbase64 (7.24.10)

WorkflowInterface.addPublicMessage(ticketid, personidoremail, logtext);

Add a ticket change entry within ticketing

first parameter: TicketId
second parameter: Person unique id or email address
third parameter: text to add as ticket change
optional fourth parameter: array of objects with properties filename and filecontentinbase64 (7.24.10)

WorkflowInterface.addTicketChange(ticketid, personidoremail, logtext);
This action will not send an email message

Update ticket fields

first parameter: TicketId
second parameter: object containing new field values

WorkflowInterface.updateTicketFields(ticketid, fields);
fields: object with a key field to set which field should be updated, together with the new value for example: WorkflowInterface.updateTicketFields(ticketid, {"Status": "Open", "Custom": {"Field01": "Value01" }});
Possible fields: LockTicket, TicketIsRunning, Classification, Status, Description, Information, AssignedToPerson, AssignedToPersonGroup, Category, Medium, Priority, Service, Solution, ClosureCode, Custom, Requestor, RequestedFor, Pool, PlannedDeliveryDate, DeadlineDate, RequestedForAlternateName, RequestedForAlternateEmail, RequestedForAlternateTelephone, SolutionLinkAllDocuments, RequestedForTeam, WorkflowPool, TicketType, TasksType, RemoveOnDate. Since 7.23.05: CustomFields (array of objects with properties fieldname and stringvalue)

Lock ticket

first parameter: TicketId

WorkflowInterface.lockTicket(ticketid);

Unlock ticket

first parameter: TicketId

WorkflowInterface.unlockTicket(ticketid);

Set ticket to IsRunning = True

first parameter: TicketId

WorkflowInterface.enableTicketIsRunning(ticketid);

Set ticket to IsRunning = False

WorkflowInterface.disableTicketIsRunning(ticketid);

Create a new, blank Task within a ticket

first parameter: TicketId
second parameter: object containing new field values
third optional parameter (since 7.23.10): the id of the person used as requestor person

WorkflowInterface.addTask(ticketid, fields); 
returns: the new task id

Update fields of a task

first parameter: TicketId
second parameter: TaskId
third parameter: object containing new field values

WorkflowInterface.updateTask(ticketid, taskid, fields);
fields: object with a key field to set which field should be updated, together with the new value for example: WorkflowInterface.updateTask(ticketid, taskid, {"Status": "Open","Description":"My descriptionb" });
Possible fields: Description, AssignedToPersonGroup, AssignedToPerson, DeliveryDate, Information, Solution, LockedTicket, IsCompleted, ExternalReference, ExternalResolved, LinkAllTicketDocuments, Status, Priority, DeadlineDate, since 7.23.09: Category, ConfigurationItem, since 7.24.12: Subcategory

Add a message to a task (7.24.10)

first parameter: TicketId
second parameter: TaskId
third parameter: person
fourth parameter: text

WorkflowInterface.addTaskMessage(1500, 150, "john@doe.com", "text");

External system acknowledged a task (7.25.01)

first parameter: TicketId
second parameter: TaskId
third parameter: person
fourth parameter: externalLinkReference
fifth parameter: extraMessage

WorkflowInterface.taskAcknowledgementFromExternal(1500, 150, "john@doe.com", "EXT-12345", "Ticket received");

External system adds an update message to a task (7.25.01)

first parameter: TicketId
second parameter: TaskId
third parameter: person
fourth parameter: updateMessage

WorkflowInterface.taskUpdateMessageFromExternal(1500, 150, "john@doe.com", "Update information");

External system reassigns a task (7.25.01)

first parameter: TicketId
second parameter: TaskId
third parameter: person
fourth parameter: updateMessage

WorkflowInterface.taskReassignmentFromExternal(1500, 150, "john@doe.com", "The solution");

Send update message to an external task (7.25.01)

first parameter: TicketId
second parameter: TaskId
third parameter: person
fourth parameter: updateMessage

WorkflowInterface.taskUpdateMessageToExternal(1500, 150, "john@doe.com", "Update information");

Send update message to an external task, only if the logged in user has the rights for this (7.25.01)

first parameter: TicketId
second parameter: TaskId
third parameter: updateMessage

WorkflowInterface.taskUpdateMessageToExternalSecure(1500, 150, "Update information");

Reject the solution for an external task (7.25.01)

first parameter: TicketId
second parameter: TaskId
third parameter: person
fourth parameter: rejectMessage

WorkflowInterface.taskRejectSolutionToExternal(1500, 150, "john@doe.com", "Reject info");

Reject the solution for an external task, only if the logged in user has the rights for this (7.25.01)

first parameter: TicketId
second parameter: TaskId
third parameter: rejectMessage

WorkflowInterface.taskRejectSolutionToExternalSecure(1500, 150, "Reject info");

Get information for a task (7.21.07)

first parameter: task id

WorkflowInterface.getTask(100);
returns: object with properties id, processinstanceid, deliverydate, deadlinedate, dateadded, datecompleted, completed, requestor (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtoperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtopersongroup (object with properties id, name and description), description, information, priority (object with properties code and name), status (object with properties code and name), solution, duestatus, linkallticketdocuments, documentkeys (array of keys in string), hasexternallink, externallinkreference, lockedticket, since 7.23.09 category (object with properties code and name), configurationitem (object with properties code and name), since 7.24.12 subcategory (object with properties code and name), since 7.25.01 updatemessageavailable, rejectsolutionavailable in JSON

Get all tasks for a ticket (7.21.07)

first parameter: ticket id

WorkflowInterface.getTasks(1500);
returns: array of objects with properties id, processinstanceid, deliverydate, deadlinedate, dateadded, datecompleted, completed, requestor (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtoperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtopersongroup (object with properties id, name and description), description, information, priority (object with properties code and name), status (object with properties code and name), solution, duestatus, linkallticketdocuments, documentkeys (array of keys in string), hasexternallink, externallinkreference, lockedticket, since 7.23.09 category (object with properties code and name), configurationitem (object with properties code and name), since 7.24.10: messages (array of objects with properties date, person, text), since 7.24.12 subcategory (object with properties code and name), since 7.25.01 updatemessageavailable, rejectsolutionavailable in JSON

Emails (since 7.21.06)

Get an email layout

first parameter: name of the email layout

WorkflowInterface.getEmailLayout(name);
returns: the body of the email layout in the default language
When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.

Get an email layout in a specific language

first parameter: name of the email layout
second parameter: id of the desired language

WorkflowInterface.getEmailLayoutWithLanguageId(name, languageid);
returns: the body of the email layout in the desired language
When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.

Get the default email layout

WorkflowInterface.getDefaultEmailLayout();
returns: the body of the default email layout in the default language
When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.

Get the default email layout in a specific language

first parameter: id of the desired language

WorkflowInterface.getDefaultEmailLayoutWithLanguageId(languageid);
returns: the body of the default email layout in the desired language
When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.

Get an email template (7.22.09)

first parameter: name of the email template
optional second parameter: language id you wish to use

WorkflowInterface.getEmailTemplate(name);
returns: an object with properties subject, body and attachments (array of objects with properties url and name) in JSON

Send an email

first parameter: full name of the receiver
second parameter: email address of the receiver
third parameter: subject of the email
fourth parameter: content of the email

WorkflowInterface.sendEmail(toName, toEmail, subject, content);
sends the email immediately when "Send immediately" is enabled in the settings, will add the email to the queue otherwise

Queue an email

first parameter: full name of the receiver
second parameter: email address of the receiver
third parameter: subject of the email
fourth parameter: content of the email

WorkflowInterface.queueEmail(toName, toEmail, subject, content);
adds the email to the queue

Send an email - advanced

first parameter: object with properties

WorkflowInterface.sendEmailAdvanced(properties);
Possible properties: from, fromemail, fromname, to, toemail, toname, cc, ccemail, ccname, bcc, bccemail, bccname, attachments, subject, content, ishtml, disableoverwriteto, processinstanceid
from: can be a string (email address) or an object with the properties 'email' and 'name'
to, cc and bcc: can be a string (email address), an object with the properties 'email' and 'name' or an array with strings and or objects with the properties 'email' and 'name'
attachments: can be a string (location of the file), an object with the properties 'url' and 'name' or an array with strings and or objects with the properties 'url' and 'name'
disableoverwriteto: boolean to specify whether the "Send all e-mails only to" should be ignored or not
processinstanceid: id of the workflow ticket to link this email to
Required properties: subject, content and at least one 'to' addressee are required
Example: WorkflowInterface.sendEmailAdvanced({"to": "raymond@smt-x.com", "cc": [{email: "dominic@smt-x.com", name: "Dominic"}], "subject": "The subject of my email", "content": "The <strong>content</strong> of my email" });
sends the email immediately when "Send immediately" is enabled in the settings, will add the email to the queue otherwise
Since 7.23.05: returns the id of the record

Queue an email - advanced

first parameter: object with properties

WorkflowInterface.queueEmailAdvanced(properties);
Possible properties: from, fromemail, fromname, to, toemail, toname, cc, ccemail, ccname, bcc, bccemail, bccname, attachments, subject, content, ishtml, disableoverwriteto, processinstanceid
from: can be a string (email address) or an object with the properties 'email' and 'name'
to, cc and bcc: can be a string (email address), an object with the properties 'email' and 'name' or an array with strings and or objects with the properties 'email' and 'name'
attachments: can be a string (location of the file), an object with the properties 'url' and 'name' or an array with strings and or objects with the properties 'url' and 'name'
disableoverwriteto: boolean to specify whether the "Send all e-mails only to" should be ignored or not
processinstanceid: id of the workflow ticket to link this email to
Required properties: subject, content and at least one 'to' addressee are required
Example: WorkflowInterface.queueEmailAdvanced({"to": "raymond@smt-x.com", "cc": [{email: "dominic@smt-x.com", name: "Dominic"}], "subject": "The subject of my email", "content": "The <strong>content</strong> of my email" });
adds the email to the queue
Since 7.23.05: returns the id of the record

StudioInterface

Get the full query string

StudioInterface.getQueryString();
return: the full query string (without the leading question mark)

Get all keys from the query string parameter collection (7.22.03)

StudioInterface.getAllQueryStringKeys();
return: an array of strings with all the keys of the query string parameters for the current request

Get a value from the query string

StudioInterface.getQueryStringValue('name');
return: the value of the query string parameter for the current request

Get values in an array from the query string (7.24.03)

StudioInterface.getQueryStringValues('name');
return: the values of the query string parameter for the current request in an array

Get all keys from the header collection (7.22.03)

StudioInterface.getAllHeaderKeys();
return: an array of strings with all the keys of the headers for the current request

Get a value from the header

first parameter: name

StudioInterface.getHeaderValue('name');
return: the value of the header parameter for the current request

Get values in an array from the header (7.24.03)

first parameter: name

StudioInterface.getHeaderValues('name');
return: the values of the header parameter for the current request in an array

Get all keys from the server variables collection (7.24.02)

StudioInterface.getAllServerVariableKeys();
return: an array of strings with all the keys of the server variables collection for the current request

Get a value from the server variables (7.24.02)

first parameter: name

StudioInterface.getServerVariableValue('REMOTE_ADDR');
return: the value of the server variable for the current request

Get values in an array from the server variables (7.24.03)

first parameter: name

StudioInterface.getServerVariableValues('REMOTE_ADDR');
return: the values in an array of the server variable for the current request

Gets all the application session keys (7.25.01)

StudioInterface.getAllAppSessionKeys();
return: an array of strings with all the keys

Gets an application session value (7.25.01)

first parameter: name

StudioInterface.getAppSessionValue('name');
return: the value (object)

Sets an application session value (7.25.01)

first parameter: name
second parameter: value

StudioInterface.setAppSessionValue('sessionkeyname', 'sessionkeyvalue');
return: nothing

Removes an application session object (7.25.01)

first parameter: name

StudioInterface.removeAppSession('sessionkeyname');
return: nothing

Get all keys from the cookie collection (7.22.03)

StudioInterface.getAllCookieKeys();
return: an array of strings with all the keys of the cookies for the current request

Get a value from the cookie

first parameter: name

StudioInterface.getCookieValue('name');
return: the value (url decoded) of the cookie for the current request

Get a raw value from the cookie (7.24.06)

first parameter: name

StudioInterface.getCookieValueRaw('name');
return: the value (not url decoded) of the cookie for the current request

Set a cookie (7.22.03)

Adds a cookie, if no expire days is provided, then it's a session cookie (will be removed when session ends)

first parameter: name
second parameter: value (will be url encoded since 7.24.06)
third parameter (optional): expire in nr of days (a negative value will remove the cookie)

StudioInterface.setCookie('cookiename', 'cookievalue');
return: nothing

Set a cookie with options (7.24.10)

Adds a cookie using the options provided

first parameter: name
second parameter: value (will be url encoded)
third parameter: object with supported properties: httponly, path, domain, secure and expires

StudioInterface.setCookieWithOptions('cookiename', 'cookievalue', { "HttpOnly": false });
return: nothing

Set a cookie value raw (7.24.06)

Adds a cookie, if no expire days is provided, then it's a session cookie (will be removed when session ends)

first parameter: name
second parameter: value (will not be url encoded)
third parameter (optional): expire in nr of days (a negative value will remove the cookie)

StudioInterface.setCookieRaw('cookiename', 'cookievalue');
return: nothing

Set a cookie value raw with options (7.24.10)

Adds a cookie using the options provided

first parameter: name
second parameter: value (will not be url encoded)
third parameter: object with supported properties: httponly, path, domain, secure and expires

StudioInterface.setCookieRawWithOptions('cookiename', 'cookievalue', { "HttpOnly": false });
return: nothing

Get all keys from the posted form collection (7.22.03)

StudioInterface.getAllFormKeys();
return: an array of strings with all the keys of the posted form collection for the current request

Get a value from the posted form collection

first parameter: name

StudioInterface.getFormValue('name');
return: the value from the posted form collection for the current request

Get values in an array from the posted form collection (7.24.03)

first parameter: name

StudioInterface.getFormValues('name');
return: the values in an array from the posted form collection for the current request

Get the http method for the current request

StudioInterface.getHttpMethod();
return: the current http method (GET, POST, …)

Get the content type of the current request

StudioInterface.getContentType();
return: the content type (text/plain, application/json, …)

Get the full posted content as string

StudioInterface.getPostedContent();
return: posted content

Check if the HTTP request has a posted file (7.23.12)

optional first parameter: allextensionsallowed - default false (7.24.10)

StudioInterface.hasPostedFile();
return: true or false

Get information about the posted file in the HTTP request (7.23.12)

optional first parameter: allextensionsallowed - default false (7.24.10)

StudioInterface.getPostedFileInfo();
return: object with properties filename, contenttype and contentlength in JSON

Get information about the multiple posted files in the HTTP request (7.24.10)

optional first parameter: allextensionsallowed - default false

StudioInterface.getPostedFileInfos();
return: array of object with properties filename, contenttype and contentlength in JSON

Save a posted file (7.23.12)

first parameter: foldername where the file should be stored
optional second parameter: filename to use (if empty the original one is used)
optional third parameter: allextensionsallowed - default false (7.24.10)

StudioInterface.savePostedFile('C:\\temp\\');
return: nothing

Get the posted file from the HTTP request in base64 (7.24.09)

optional first parameter: allextensionsallowed - default false (7.24.10)

StudioInterface.getPostedFileInBase64();
return: the posted file in base64

Get the multiple posted files from the HTTP request in base64 (7.24.10)

optional first parameter: allextensionsallowed - default false

StudioInterface.getPostedFilesInBase64();
return: array of posted files in base64

Convert posted Excel file to JSON array (since 7.25.02)

optional parameter 1: object with possible properties: WorksheetName, OnlyUseStringType (when true, all values will be in string)

StudioInterface.excelAsPostedFileToJson();
returns: the JSON respresentation of the Excel file

Get the current language culture

StudioInterface.getCurrentLanguageCulture();
return: the culture (nl-BE, en-GB, …)

Get the current language name

StudioInterface.getCurrentLanguageName();
return: the name (English, Nederlands, …)

Get the current language id

StudioInterface.getCurrentLanguageId();
return: the id (1, 2, …)

Check if there is a logged in person (7.21.07)

StudioInterface.hasLoggedInPerson();
return: true or false

Get the logged in person (7.21.07)

StudioInterface.getLoggedInPerson();
return: object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON

Get the id of the logged in person (7.23.08)

StudioInterface.getLoggedInPersonId();
return: the id

Get the field value for the current logged in person

first parameter: fieldname

StudioInterface.getLoggedInPersonField('FirstName');
return: the value (Raymond, Dominic, …)
Possible fields: UniqueId, FirstName, LastName, Email, all person extra fields defined in adapters.

Get the first and last name for the current logged in person

StudioInterface.getLoggedInPersonFirstAndLastName();
return: the first and last name (Raymond Crijnen, Dominic De Vilder, …)

Get the description as defined in the settings for the current logged in person

StudioInterface.getLoggedInPersonDescription();
return: the description (Raymond Crijnen (raymond@smt-x.com - CrijnenR))

Get the dateformat as defined for the current logged in person (7.22.06)

StudioInterface.getLoggedInPersonDateFormat();
return: the dateformat (dd/MM/yyyy)

Checks if the logged in person has the specified role

first parameter: Role name

StudioInterface.loggedInPersonHasRole('Name of the role');
return: true if the user has the role, false otherwise

Checks if the logged in person has any of the specified roles (7.21.08)

first parameter: array of role names

StudioInterface.loggedInPersonHasAnyRole(['Name of the role1', 'Name of the role2']);
return: true if the user has any of the roles, false otherwise

Checks if the logged in person has all of the specified roles (7.21.08)

first parameter: array of role names

StudioInterface.loggedInPersonHasAllRoles(['Name of the role1', 'Name of the role2']);
return: true if the user has all of the roles, false otherwise

Checks if the logged in person is an admin (7.22.06)

StudioInterface.loggedInPersonIsAdmin();
return: true if the user is admin, false otherwise

Get a translation

first parameter: Category
second parameter: Label

StudioInterface.translate('Common', 'Profile');
return: the translation value for the SSP translations

Get a translation and add default value if missing (7.24.07)

first parameter: Category
second parameter: Label
third parameter: Default Value

StudioInterface.translate('Common', 'Profile', 'My Profile');
return: the translation value for the SSP translations and if it doesn't exits yet, it will be added with the default value in the default language

Get the root of the ssp location

StudioInterface.getSspRoot();
return: the http location, including the trailing slash (https:=== ssp/)

Get the http path to the current application

StudioInterface.getApplicationPath();
return: the http location, without the trailing slash (https:=== ssp/myapp)

Get the application folder name (7.22.09)

StudioInterface.getApplicationFolder();
return: the name of the folder (eg myapp)

Get the current folder name (full) inside the current application

StudioInterface.getCurrentFolderName();
return: the current full folder path, including the starting and trailing slash (/subfolder/content/)

Get the current file name inside the current application

StudioInterface.getCurrentName();
return: the current file name (index.html)

Get the current full path of the file inside the current application

StudioInterface.getCurrentPath();
return: the current file name (/subfolder/content/index.html)

Get the current full raw url (since 7.23.04)

StudioInterface.getCurrentFullRawUrl();
return: the current full raw url, eg /my-app/my-folder/my-file.txt

Get the current application raw url (since 7.23.04)

StudioInterface.getCurrentApplicationRawUrl();
return: the current full raw url minues the application folder, eg /my-folder/my-file.txt

Get the current application id (7.22.06)

StudioInterface.getCurrentApplicationId();
return: the id of the application

Get the ticks of the last modified date of the current application (7.23.02)

StudioInterface.getCurrentApplicationLastModifiedTicks();
return: the ticks of the last modified date of the application

renders the application file as a string

first parameter: string to be rendered

StudioInterface.renderAsString('/subfolder/content/index.html');
return: the rendered content

renders the application file as a string, passing thru the parameters to the rendering script

first parameter: Application file
second parameter: object with parameters

StudioInterface.renderAsStringWithParameters('/subfolder/content/index.html', { 'Title': 'My title', 'Summary': 'My summary' });
return: the rendered content (the parameters are accessible in the processing script of the file to render, use g_parameters)

renders the application file and returns the rendered object

first parameter: Application file

StudioInterface.render('/subfolder/content/index.html');
return: the rendered object with these properties: action, content, contenttype, templatezones, templateparameters

renders the application file, passing thru the parameters to the rendering script

StudioInterface.renderWithParameters('/subfolder/content/index.html', { 'Title': 'My title', 'Summary': 'My summary' });
return: the rendered object (see .render for details)

Get the value for the application variable

first parameter: Variable name

StudioInterface.getVariableValue('my variable');
return: the value (type is depending on the variable)

Get the value for the application variable, passing thru the parameters to the variable script

first parameter: Variable name
second parameter: object with parameters (passed through to the variable script)

StudioInterface.getVariableValueWithParameters('my custom variable function', { 'Number': 8 });
return: the value (type is depending on the variable)

Get the value for the application setting (7.24.12)

first parameter: Setting name

StudioInterface.getSettingValue('my setting');
return: the value (type is depending on the setting)

Get the value for the application setting, passing thru the parameters to the setting script (7.24.12)

first parameter: Setting name
second parameter: object with parameters (passed through to the setting script)

StudioInterface.getSettingValueWithParameters('my custom setting function', { 'Number': 8 });
return: the value (type is depending on the setting)

Schedule a studio task to run on the next SSP Scheduler run (7.23.07)

first parameter: name of the task

StudioInterface.scheduleStudioTaskToRunOnNextSchedulerRun('my task');
return: nothing

Views (7.22.06)

getViewCountByName

Get the count of a view by it's name

first parameter is the name of the view
optional second parameter can be an object with properties "GetFromSource" or "AllowDbAccess"

StudioInterface.getViewCountByName("view1");
returns: the count of the view

getCachedViewCountByName (7.24.07)

Get the count of a view by it's name only by fetching it from the cache

first parameter is the name of the view

StudioInterface.getViewCountByName("view1");
returns: the count of the view if it's found in the cache, null otherwise

getViewCountById

Get the count of a view by it's id

first parameter is the id of the view
optional second parameter can be an object with properties "GetFromSource" or "AllowDbAccess"

StudioInterface.getViewCountById(1);
returns: the count of the view

getCachedViewCountById (7.24.07)

Get the count of a view by it's id only by fetching it from the cache

first parameter is the id of the view

StudioInterface.getViewCountById(1);
returns: the count of the view if found in cache, null otherwise

getViewDataByName

Get the data of a view by it's name

first parameter is the name of the view

StudioInterface.getViewDataByName("view1");
returns: the data of the view in JSON

searchViewDataByName (7.22.08)

Search the data of a view by it's name

first parameter is the name of the view
second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum. Update since 7.23.05: extra possible property: Connector and Filters, extra FilterOperator: SubFilter
optional third parameter is an object with properties PageIndex, PageSize, OrderBy

StudioInterface.searchViewDataByName("view1", [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
returns: the data of the search results in JSON

getViewDataByNames

Get the data of multiple views by their names

first parameter is an array of the name of the views

StudioInterface.getViewDataByNames(["view1", "view2"]);
returns: the data of the views in JSON

searchViewDataByNames (7.22.08)

Search the data of a view by their names

first parameter is an array of the name of the views
second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum. Update since 7.23.05: extra possible property: Connector and Filters, extra FilterOperator: SubFilter
optional third parameter is an object with properties PageIndex, PageSize, OrderBy

StudioInterface.searchViewDataByName(["view1", "view2"], [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
returns: the data of the search results in JSON

getViewDataForTicketsByName

Search for tickets and get the results back as defined in the view by the views name

first parameter is the name of the view
second parameter is an object with the search predicates (possible properties are "CustomKey", "Id", "Status", "Keywords", "RequestorId", "DateStartedFrom", "DateStartedTo", "DateEndedFrom", "DateEndedTo")
optional third parameter is an object with the paging settings

StudioInterface.getViewDataForTicketsByName("view1", { "Status": "Open" });
returns: the tickets formatted as defined in the view in JSON

getViewDataById

Get the data of a view by it's id

first parameter is the id of the view

StudioInterface.getViewDataById(1);
returns: the data of the view in JSON

searchViewDataById (7.22.08)

Get the data of a view by it's id

first parameter is the id of the view
second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum. Update since 7.23.05: extra possible property: Connector and Filters, extra FilterOperator: SubFilter
optional third parameter is an object with properties PageIndex, PageSize, OrderBy

StudioInterface.searchViewDataById(1, [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
returns: the data of the search results in JSON

getViewDataByIds

Get the data of multiple views by their ids

first parameter is an array of ids of the views

StudioInterface.getViewDataByIds([1, 2]);
returns: the data of the views in JSON

searchViewDataByIds (7.22.08)

Get the data of multiple views by their ids

first parameter is an array of ids of the views
second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum. Update since 7.23.05: extra possible property: Connector and Filters, extra FilterOperator: SubFilter
optional third parameter is an object with properties PageIndex, PageSize, OrderBy

StudioInterface.searchViewDataByName([1, 2], [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
returns: the data of the search results in JSON

getViewDataForTicketsById

Search for tickets and get the results back as defined in the view by the views id

first parameter is the id of the view
second parameter is an object with the search predicates (possible properties are "CustomKey", "Id", "Status", "Keywords", "RequestorId", "DateStartedFrom", "DateStartedTo", "DateEndedFrom", "DateEndedTo")
optional third parameter is an object with the paging settings

StudioInterface.getViewDataForTicketsById(1, { "Status": "Open" });
returns: the tickets formatted as defined in the view in JSON

Quick Requests (7.24.07)

Get the quick requests

Get all the quick requests

CommonInterface.getQuickRequests();
returns: array of object with properties id, typeid, typename, iconurl, cssclass, name and url in JSON

Get the quick requests SECURE

Get the quick requests for the logged in user

CommonInterface.getQuickRequestsSecure();
returns: array of object with properties id, typeid, typename, iconurl, cssclass, name and url in JSON

Service Catalog Interface

General

Rebuild the search indexes (7.23.07)

no parameters

ServiceCatalogInterface.rebuildSearchIndexes();
return: nothing

Get the quality note types (7.23.07)

optional first parameters is an object possible key LanguageId

ServiceCatalogInterface.getQualityNoteTypes();
return: array of objects with properties guid, canselectreviewcycle and name

Published versions

Get secure count of all published records (7.21.07)

no parameters
security: this function returns the count of all published records (services and knowledge articles) and checks the current user security profile

ServiceCatalogInterface.getCountPublishedRecordsSecure();
return: number

Get secure list of all published records

optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
security: this function returns all published records (services and knowledge articles) and checks the current user security profile for all returning authorized records

ServiceCatalogInterface.getAllPublishedRecordsSecure();
return:  An array of all currently published records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get secure count of published records by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with LanguageId (7.22.08)
security: this function returns the count of all published records (services and knowledge articles) and checks the current user security profile

ServiceCatalogInterface.searchCountPublishedRecordsSecure({ tag: "bike" });
return: number

Get secure list of published records by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all published records (services and knowledge articles) and checks the current user security profile for all returning authorized records

ServiceCatalogInterface.searchListPublishedRecordsSecure({ tag: "bike" });
ServiceCatalogInterface.searchListPublishedRecordsSecure({ anytag: ["bike","auto"], name_contains: "transport" });
return:  An array of all currently published records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get count of all published records (7.21.07)

no parameters
security: this function returns the count of all published records (services and knowledge articles), without checking the current user security profile

ServiceCatalogInterface.getCountPublishedRecords();
return: number

Get list of all published records

optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
security: this function returns all published records (services and knowledge articles), without checking the current user security profile

ServiceCatalogInterface.getAllPublishedRecords();
return:  An array of all currently published records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get count of published records by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with LanguageId (7.22.08)
security: this function returns the count of all published records (services and knowledge articles), without checking the current user security profile

ServiceCatalogInterface.searchCountPublishedRecords({ tag: "bike" });
return: number

Get list of published records by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns published records (services and knowledge articles) that matches the search conditions, without checking the current user security profile

ServiceCatalogInterface.searchListPublishedRecords({ tag: "bike" });
ServiceCatalogInterface.searchListPublishedRecords({ anytag: ["bike","auto"], name_contains: "transport" });
return:  An array of all currently published records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get secure count of all published services (7.21.07)

no parameters
security: this function returns the count of all published services and checks the current user security profile

ServiceCatalogInterface.getCountPublishedServicesSecure();
return: number

Get secure list of all published services

optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
security: this function returns all published services and checks the current user security profile

ServiceCatalogInterface.getAllPublishedServicesSecure();
return:  An array of all currently published services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get secure count of published services by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with LanguageId (7.22.08)
security: this function returns the count of all published services and checks the current user security profile

ServiceCatalogInterface.searchCountPublishedServicesSecure({tag: "bike"});
return: number

Get secure list of published services by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all published services and checks the current user security profile

ServiceCatalogInterface.searchListPublishedServicesSecure({tag: "bike"});
return:  An array of all currently published services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get count of all published services (7.21.07)

no parameters
security: this function returns the count all published services, without checking the current user security profile

ServiceCatalogInterface.getCountPublishedServices();
return: number

Get list of all published services

optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
security: this function returns all published services, without checking the current user security profile

ServiceCatalogInterface.getAllPublishedServices();
return:  An array of all currently published services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get count of published services by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with LanguageId (7.22.08)
security: this function returns the count all published services, without checking the current user security profile

ServiceCatalogInterface.searchCountPublishedServices({tag: "bike"});
return: number

Get list of published services by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all published services, without checking the current user security profile

ServiceCatalogInterface.searchListPublishedServices({tag: "bike"});
return:  An array of all currently published services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get secure count of all published knowledge articles (7.21.07)

no parameters
security: this function returns the count of all published knowledge articles and checks the current user security profile

ServiceCatalogInterface.getCountPublishedKnowledgeArticlesSecure();
return: number

Get secure list of all published knowledge articles

optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
security: this function returns all published knowledge articles and checks the current user security profile

ServiceCatalogInterface.getAllPublishedKnowledgeArticlesSecure();
return:  An array of all currently published knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get secure count of published knowledge articles by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with LanguageId (7.22.08)
security: this function returns the count of all published knowledge articles and checks the current user security profile

ServiceCatalogInterface.searchCountPublishedKnowledgeArticlesSecure({tag: "bike"});
return: number

Get secure list of published knowledge articles by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all published knowledge articles and checks the current user security profile

ServiceCatalogInterface.searchListPublishedKnowledgeArticlesSecure({tag: "bike"});
return:  An array of all currently published knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get count of all published knowledge articles (7.21.07)

no parameters
security: this function returns the count all published knowledge articles, without checking the current user security profile

ServiceCatalogInterface.getCountPublishedKnowledgeArticles();
return: number

Get list of all published knowledge articles

optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
security: this function returns all published knowledge articles, without checking the current user security profile

ServiceCatalogInterface.getAllPublishedKnowledgeArticles();
return:  An array of all currently published knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get count of published knowledge articles by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with LanguageId (7.22.08)
security: this function returns the count all published knowledge articles, without checking the current user security profile

ServiceCatalogInterface.searchCountPublishedKnowledgeArticles({tag: "bike"});
return: number

Get list of published knowledge articles by searching (7.21.07)

first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all published knowledge articles, without checking the current user security profile

ServiceCatalogInterface.searchListPublishedKnowledgeArticles({tag: "bike"});
return:  An array of all currently published knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get published service overview (7.24.02)

first parameter: serviceguid
optional second parameter: object with LanguageId
security: Returns a overview of the service, without checking the current user security profile

ServiceCatalogInterface.getPublishedServiceOverview(guid)
return: the same fields as the list method returns

Get secure published service overview (7.24.02)

first parameter: serviceguid
optional second parameter: object with LanguageId
security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getPublishedServiceOverviewSecure(guid)
return: the same fields as the list method returns

Get multiple published services overview (7.24.02)

first parameter: array with serviceguids
optional second parameter: object with LanguageId
security: Returns a overview of the service, without checking the current user security profile

ServiceCatalogInterface.getPublishedServicesOverview([guid1, guid2])
return: an array with services containing the same fields as the list method returns

Get all published services overview (7.24.02)

optional first parameter: object with LanguageId
security: Returns a overview of the service, without checking the current user security profile

ServiceCatalogInterface.getAllPublishedServicesOverview()
return: an array with services containing the same fields as the list method returns

Get secure multiple published services overview (7.24.02)

first parameter: array with serviceguids
optional second parameter: object with LanguageId
security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getPublishedServicesOverviewSecure([guid1, guid2])
return: an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get secure all published services overview (7.24.02)

optional first parameter: object with LanguageId
security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getAllPublishedServicesOverviewSecure()
return: an array with services containing the same fields as the list method returns

Get published service summary

first parameter: serviceguid
optional second parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service, without checking the current user security profile

ServiceCatalogInterface.getPublishedServiceSummary(guid)
return: the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get secure published service summary

first parameter: serviceguid
optional second parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getPublishedServiceSummarySecure(guid)
return: the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get multiple published services summary

first parameter: array with serviceguids
optional second parameter: object with LanguageId (7.22.08)
security: Returns a summary of the service, without checking the current user security profile

ServiceCatalogInterface.getPublishedServicesSummary([guid1, guid2])
return: an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get all published services summary (7.21.07)

optional first parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service, without checking the current user security profile

ServiceCatalogInterface.getAllPublishedServicesSummary()
return: an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get secure multiple published services summary

first parameter: array with serviceguids
optional second parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getPublishedServicesSummarySecure([guid1, guid2])
return: an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get secure all published services summary (7.21.07)

optional first parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getAllPublishedServicesSummarySecure()
return: an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get published service details

first parameter: serviceguid
optional second parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details, without checking the current user security profile

ServiceCatalogInterface.getPublishedServiceDetail(guid)
return: all fields, including template fields for the given service guid

Get secure published service details

first parameter: serviceguid
optional second parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getPublishedServiceDetailSecure(guid)
return: all fields, including template fields for the given service guid

Get multiple published services details

first parameter: array with serviceguids
optional second parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details, without checking the current user security profile

ServiceCatalogInterface.getPublishedServicesDetail([guid1, guid2])
return: an array with services containing all fields, including template fields for the given service guids

Get all published services details (7.21.07)

optional first parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details, without checking the current user security profile

ServiceCatalogInterface.getAllPublishedServicesDetail()
return: an array with services containing all fields, including template fields

Get secure multiple published services details

first parameter: array with serviceguids
optional second parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getPublishedServicesDetailSecure([guid1, guid2])
return: an array with services containing all fields, including template fields for the given service guids

Get secure all published services details (7.21.07)

optional first parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getAllPublishedServicesDetailSecure()
return: an array with services containing all fields, including template fields

Get published service part values (7.21.07)

first parameter: serviceguid
second parameter: array of internal names of the parts (pass null to get all parts)
optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values, without checking the current user security profile

ServiceCatalogInterface.getPublishedServiceParts(guid, ["part1", "part2"])
return: template fields for the given service guid

Get secure published service part values (7.21.07)

first parameter: serviceguid
second parameter: array of internal names of the parts (pass null to get all parts)
optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getPublishedServicePartsSecure(guid, ["part1", "part2"])
return: template fields for the given service guid

Get multiple published services part values (7.21.07)

first parameter: array with serviceguids
second parameter: array of internal names of the parts (pass null to get all parts)
optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values, without checking the current user security profile

ServiceCatalogInterface.getPublishedServicesParts([guid1, guid2], ["part1", "part2"])
return: template fields for the given service guid

Get secure multiple published services details (7.21.07)

first parameter: array with serviceguids
second parameter: array of internal names of the parts (pass null to get all parts)
optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values, without checking the current user security profile

ServiceCatalogInterface.getPublishedServicesPartsSecure([guid1, guid2], ["part1", "part2"])
return: template fields for the given service guid

Get all published services part values (7.21.07)

first parameter: array of internal names of the parts (pass null to get all parts)
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values for all services, without checking the current user security profile

ServiceCatalogInterface.getAllPublishedServicesParts(["part1", "part2"])
return: template fields

Get secure all published services details (7.21.07)

first parameter: array of internal names of the parts (pass null to get all parts)
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values for all services and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getAllPublishedServicesPartsSecure(["part1", "part2"])
return: template fields

Search published services using text search (with Lucene) (7.21.11)

first parameter: language id
second parameter: the text to search (allows for * and ?) (since 7.23.12: can be null, then no text filter is set, usefull when using 'serviceguid(s)' in optional third parameter)
optional third parameter: object with properties 'itemsperpage' (default 100), 'after' (pass the object 'lastinfo' from the previous search result), 'escapesearchtext', 'templatename', 'templatetype', 'servicetype' and since 7.23.12: serviceguid, name, summary, owner, ownerdeputy, manager, tag, provider, receiver, documentname, requestname, part, includesuggestions
security: this function returns all published services, without checking the current user security profile

ServiceCatalogInterface.textSearch(1, "how to ride a bike", { templatetype: "Knowledge_article" });
return:  An object with properties 'totalhits' (total amount of hits), 'entries' (array of search result entries containing possibly the following data: guid, name, summary, servicetype, templatename, templatetype and since 7.23.12: dataobject, owner, ownerdeputy, manager, tags, provider, receivers, documentnames, documents, requestnames, requests, parts), 'lastinfo' (contains the needed info to fetch the next batch of results) and since 7.23.12: 'suggestions' (array of objects with properties: text, totalhits)

Search published services using multiple texts search (with Lucene) (7.23.12)

first parameter: language id
second parameter: the array of text to search (allows for * and ?) (can be null, then no text filter is set, usefull when using 'serviceguid(s)' in optional third parameter)
optional third parameter: object with properties 'itemsperpage' (default 100), 'after' (pass the object 'lastinfo' from the previous search result), 'escapesearchtext', 'templatename', 'templatetype', 'servicetype', serviceguid, name, summary, owner, ownerdeputy, manager, tag, provider, receiver, documentname, requestname, part, includesuggestions
security: this function returns all published services, without checking the current user security profile

ServiceCatalogInterface.textsSearch(1, ["how to ride a bike", "how to drive a car"], { templatetype: "Knowledge_article" });
return:  An array of the same size as the second input parameter of objects with properties 'totalhits' (total amount of hits), 'entries' (array of search result entries containing possibly the following data: guid, name, summary, servicetype, templatename, templatetype and since 7.23.12: dataobject, owner, ownerdeputy, manager, tags, provider, receivers, documentnames, documents, requestnames, requests, parts), 'lastinfo' (contains the needed info to fetch the next batch of results), 'suggestions' (array of objects with properties: text, totalhits)

Search secure published services using text search (with Lucene) (7.21.11)

first parameter: language id
second parameter: the text to search (allows for * and ?) (since 7.23.12: can be null, then no text filter is set, usefull when using 'serviceguid(s)' in optional third parameter)
optional third parameter: object with properties 'itemsperpage' (default 100), 'after' (pass the object 'lastinfo' from the previous search result), 'escapesearchtext', 'templatename', 'templatetype', 'servicetype' and since 7.23.12: serviceguid, name, summary, owner, ownerdeputy, manager, tag, provider, receiver, documentname, requestname, part, includesuggestions
security: this function returns all published services and checks the current user security profile

ServiceCatalogInterface.textSearchSecure(1, "how to ride a bike", { templatetype: "Knowledge_article" });
return:  An object with properties 'totalhits' (total amount of hits), 'entries' (array of search result entries containing possibly the following data: guid, name, summary, servicetype, templatename, templatetype and since 7.23.12: dataobject, owner, ownerdeputy, manager, tags, provider, receivers, documentnames, documents, requestnames, requests, parts), 'lastinfo' (contains the needed info to fetch the next batch of results) and since 7.23.12: 'suggestions' (array of objects with properties: text, totalhits)

Search secure published services using multiple texts search (with Lucene) (7.23.12)

first parameter: language id
second parameter: the array of texts to search (allows for * and ?) (can be null, then no text filter is set, usefull when using 'serviceguid(s)' in optional third parameter)
optional third parameter: object with properties 'itemsperpage' (default 100), 'after' (pass the object 'lastinfo' from the previous search result), 'escapesearchtext', 'templatename', 'templatetype', 'servicetype' and since 7.23.12: serviceguid, name, summary, owner, ownerdeputy, manager, tag, provider, receiver, documentname, requestname, part, includesuggestions
security: this function returns all published services and checks the current user security profile

ServiceCatalogInterface.textsSearchSecure(1, ["how to ride a bike", "how to drive a car"], { templatetype: "Knowledge_article" });
return:  An array of the same size as the second input parameter with objects with properties 'totalhits' (total amount of hits), 'entries' (array of search result entries containing possibly the following data: guid, name, summary, servicetype, templatename, templatetype and since 7.23.12: dataobject, owner, ownerdeputy, manager, tags, provider, receivers, documentnames, documents, requestnames, requests, parts), 'lastinfo' (contains the needed info to fetch the next batch of results), 'suggestions' (array of objects with properties: text, totalhits)

Search for word suggestions based on published services (with Lucene) (7.23.12)

first parameter: language id
second parameter: the word the search suggestions for
optional third parameter: object with properties 'nrofresults' (default 5)

ServiceCatalogInterface.textSearchSuggestSimilar(1, "artilce");
return:  A json encoded array of suggestions (string)

Search for multiple word suggestions bsaed on published services (with Lucene) (7.23.12)

first parameter: language id
second parameter: the array of words to search suggestions for
optional third parameter: object with properties 'nrofresults' (default 5)

ServiceCatalogInterface.textsSearchSuggestSimilar(1, ["artilce", "atricle"]);
return:  An array of the same size as the second input parameter of arrays with suggestions (string)

Service versions

Get service version overview (7.24.02)

first parameter: serviceguid
second parameter: versionnumber
optional third parameter: object with LanguageId
security: Returns a overview of the service, without checking the current user security profile

ServiceCatalogInterface.getServiceVersionOverview(guid, versionnumber)
return: the same fields as the list method returns

Get secure service version overview (7.24.02)

first parameter: serviceguid
second parameter: versionnumber
optional third parameter: object with LanguageId
security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceVersionOverviewSecure(guid, versionnumber)
return: the same fields as the list method returns

Get service version summary (7.21.12)

first parameter: serviceguid
second parameter: versionnumber
optional third parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service, without checking the current user security profile

ServiceCatalogInterface.getServiceVersionSummary(guid, versionnumber)
return: the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get secure service version summary (7.21.12)

first parameter: serviceguid
second parameter: versionnumber
optional third parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceVersionSummarySecure(guid, versionnumber)
return: the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get service version details (7.21.12)

first parameter: serviceguid
second parameter: versionnumber
optional third parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details, without checking the current user security profile

ServiceCatalogInterface.getServiceVersionDetail(guid, versionnumber)
return: all fields, including template fields for the given service guid and versionnumber

Get secure service version details (7.21.12)

first parameter: serviceguid
second parameter: versionnumber
optional third parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceVersionDetailSecure(guid, versionnumber)
return: all fields, including template fields for the given service guid and versionnumber

Services

Get secure count of all records (7.21.12)

no parameters
security: this function returns the count of all records (services and knowledge articles) and checks the current user security profile

ServiceCatalogInterface.getCountRecordsSecure();
return: number

Get secure list of all records (7.21.12)

optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all records (services and knowledge articles) and checks the current user security profile for all returning authorized records

ServiceCatalogInterface.getAllRecordsSecure();
return:  An array of all currently records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get count of all records (7.21.12)

no parameters
security: this function returns the count of all records (services and knowledge articles), without checking the current user security profile

ServiceCatalogInterface.getCountRecords();
return: number

Get list of all records (7.21.12)

optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all records (services and knowledge articles), without checking the current user security profile

ServiceCatalogInterface.getAllRecords();
return:  An array of all currently records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get secure count of all services (7.21.12)

no parameters
security: this function returns the count of all services and checks the current user security profile

ServiceCatalogInterface.getCountServicesSecure();
return: number

Get secure list of all services (7.21.12)

optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all services and checks the current user security profile

ServiceCatalogInterface.getAllServicesSecure();
return:  An array of all currently services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get count of all services (7.21.12)

no parameters
security: this function returns the count all services, without checking the current user security profile

ServiceCatalogInterface.getCountServices();
return: number

Get list of all services (7.21.12)

optional first parameter: object with LanguageId (7.22.08)
security: this function returns all services, without checking the current user security profile

ServiceCatalogInterface.getAllServices();
return:  An array of all currently services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get secure count of all knowledge articles (7.21.12)

no parameters
security: this function returns the count of all knowledge articles and checks the current user security profile

ServiceCatalogInterface.getCountKnowledgeArticlesSecure();
return: number

Get secure list of all knowledge articles (7.21.12)

optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all knowledge articles and checks the current user security profile

ServiceCatalogInterface.getAllKnowledgeArticlesSecure();
return:  An array of all currently knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get count of all knowledge articles (7.21.12)

no parameters
security: this function returns the count all knowledge articles, without checking the current user security profile

ServiceCatalogInterface.getCountKnowledgeArticles();
return: number

Get list of all knowledge articles (7.21.12)

optional first parameter: object with LanguageId (7.22.08)
security: this function returns all knowledge articles, without checking the current user security profile

ServiceCatalogInterface.getAllKnowledgeArticles();
return:  An array of all currently knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get secure count of all records (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
security: this function returns the count of all records based on the search criteria (services and knowledge articles) and checks the current user security profile

ServiceCatalogInterface.searchCountRecordsSecure(searchcriteria);
return: number

Get secure list of all records (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all records based on the search criteria (services and knowledge articles) and checks the current user security profile for all returning authorized records

ServiceCatalogInterface.searchAllRecordsSecure(searchcriteria);
return:  An array of all currently records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get count of all records (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
security: this function returns the count of all records based on the search criteria (services and knowledge articles), without checking the current user security profile

ServiceCatalogInterface.searchCountRecords(searchcriteria);
return: number

Get list of all records (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all records based on the search criteria (services and knowledge articles), without checking the current user security profile

ServiceCatalogInterface.searchAllRecords(searchcriteria);
return:  An array of all currently records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Search secure count of all services (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
security: this function returns the count of all services based on the search criteria and checks the current user security profile

ServiceCatalogInterface.searchCountServicesSecure(searchcriteria);
return: number

Search secure list of all services (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all services based on the search criteria and checks the current user security profile

ServiceCatalogInterface.searchAllServicesSecure(searchcriteria);
return:  An array of all currently services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Search count of all services (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
security: this function returns the count all services based on the search criteria, without checking the current user security profile

ServiceCatalogInterface.searchCountServices(searchcriteria);
return: number

Search list of all services (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all services based on the search criteria, without checking the current user security profile

ServiceCatalogInterface.searchAllServices(searchcriteria);
return:  An array of all currently services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
example criteria: { templatename: ["Template 1", "Template 2"] }
 available criteria: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06)

Search secure count of all knowledge articles (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
security: this function returns the count of all knowledge articles based on the search criteria and checks the current user security profile

ServiceCatalogInterface.searchCountKnowledgeArticlesSecure(searchcriteria);
return: number

Search secure list of all knowledge articles (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all knowledge articles based on the search criteria and checks the current user security profile

ServiceCatalogInterface.searchAllKnowledgeArticlesSecure(searchcriteria);
return:  An array of all currently knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Search count of all knowledge articles (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
security: this function returns the count all knowledge articles based on the search criteria, without checking the current user security profile

ServiceCatalogInterface.searchCountKnowledgeArticles(searchcriteria);
return: number

Search list of all knowledge articles (7.22.04)

first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
security: this function returns all knowledge articles based on the search criteria, without checking the current user security profile

ServiceCatalogInterface.searchAllKnowledgeArticles(searchcriteria);
return:  An array of all currently knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.

Get service overview (7.24.02)

first parameter: serviceguid
optional second parameter: object with LanguageId
security: Returns a overview of the service, without checking the current user security profile

ServiceCatalogInterface.getServiceOverview(guid)
return: the same fields as the list method returns

Get secure service overview (7.24.02)

first parameter: serviceguid
optional second parameter: object with LanguageId
security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceOverviewSecure(guid)
return: the same fields as the list method returns

Get multiple services overview (7.24.02)

first parameter: array with serviceguids
security: Returns a overview of the service, without checking the current user security profile

ServiceCatalogInterface.getServicesOverview([guid1, guid2])
return: an array with services containing the same fields as the list method returns

Get all services overview (7.24.02)

optional first parameter: object with LanguageId
security: Returns a overview of the service, without checking the current user security profile

ServiceCatalogInterface.getAllServicesOverview()
return: an array with services containing the same fields as the list method returns

Get secure multiple services overview (7.24.02)

first parameter: array with serviceguids
optional second parameter: object with LanguageId
security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServicesOverviewSecure([guid1, guid2])
return: an array with services containing the same fields as the list method returns

Get secure all services overview (7.24.02)

optional first parameter: object with LanguageId
security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getAllServicesOverviewSecure()
return: an array with services containing the same fields as the list method returns

Get service summary (7.21.12)

first parameter: serviceguid
optional second parameter: object with properties LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service, without checking the current user security profile

ServiceCatalogInterface.getServiceSummary(guid)
return: the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get secure service summary (7.21.12)

first parameter: serviceguid
optional second parameter: object with properties LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceSummarySecure(guid)
return: the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get multiple services summary (7.21.12)

first parameter: array with serviceguids
security: Returns a summary of the service, without checking the current user security profile

ServiceCatalogInterface.getServicesSummary([guid1, guid2])
return: an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get all services summary (7.21.12)

optional first parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service, without checking the current user security profile

ServiceCatalogInterface.getAllServicesSummary()
return: an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get secure multiple services summary (7.21.12)

first parameter: array with serviceguids
optional second parameter: object with properties LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServicesSummarySecure([guid1, guid2])
return: an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get secure all services summary (7.21.12)

optional first parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getAllServicesSummarySecure()
return: an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors

Get service details (7.21.12)

first parameter: serviceguid
optional second parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details, without checking the current user security profile

ServiceCatalogInterface.getServiceDetail(guid)
return: all fields, including template fields for the given service guid
Please note that there is an optional parameter to retrieve the service details in a specific languange. Use this: ServiceCatalogInterface.getServiceDetail(guid, { LanguageId: 1 }) to get the service details in the language English. (1=English, 2=Dutch, 3=French, 4=German).

Get secure service details (7.21.12)

first parameter: serviceguid
optional second parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceDetailSecure(guid)
return: all fields, including template fields for the given service guid

Get multiple services details (7.21.12)

first parameter: array with serviceguids
optional second parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details, without checking the current user security profile

ServiceCatalogInterface.getServicesDetail([guid1, guid2])
return: an array with services containing all fields, including template fields for the given service guids

Get all services details (7.21.12)

optional second parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details, without checking the current user security profile

ServiceCatalogInterface.getAllServicesDetail()
return: an array with services containing all fields, including template fields

Get secure multiple services details (7.21.12)

first parameter: array with serviceguids
optional second parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServicesDetailSecure([guid1, guid2])
return: an array with services containing all fields, including template fields for the given service guids

Get secure all services details (7.21.12)

optional second parameter: object with properties:

- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
- LanguageId (id of the language to use) (7.22.03)
- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
- since 7.23.05: LoadRelations, LoadParents, LoadChildren

security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getAllServicesDetailSecure()
return: an array with services containing all fields, including template fields

Service parts

Get service part values (7.22.02)

first parameter: serviceguid
second parameter: array of internal names of the parts (pass null to get all parts)
optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values, without checking the current user security profile

ServiceCatalogInterface.getServiceParts(guid, ["part1", "part2"])
return: template fields for the given service guid

Get secure service part values (7.22.02)

first parameter: serviceguid
second parameter: array of internal names of the parts (pass null to get all parts)
optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServicePartsSecure(guid, ["part1", "part2"])
return: template fields for the given service guid

Get multiple services part values (7.22.02)

first parameter: array with serviceguids
second parameter: array of internal names of the parts (pass null to get all parts)
optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values, without checking the current user security profile

ServiceCatalogInterface.getServicesParts([guid1, guid2], ["part1", "part2"])
return: template fields for the given service guid

Get secure multiple services part values (7.22.02)

first parameter: array with serviceguids
second parameter: array of internal names of the parts (pass null to get all parts)
optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServicesPartsSecure([guid1, guid2], ["part1", "part2"])
return: template fields for the given service guid

Get all services part values (7.22.02)

first parameter: array of internal names of the parts (pass null to get all parts)
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values for all services, without checking the current user security profile

ServiceCatalogInterface.getAllServicesParts(["part1", "part2"])
return: template fields

Get secure all services part values (7.22.02)

first parameter: array of internal names of the parts (pass null to get all parts)
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all part values for all services and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getAllServicesPartsSecure(["part1", "part2"])
return: template fields

Service relations (7.24.02)

Get service relation

first parameter: parent serviceguid
second parameter: child serviceguid
optional third parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns the relation, without checking the current user security profile

ServiceCatalogInterface.getServiceRelation(parentserviceguid, childserviceguid)
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get secure service relation

first parameter: parent serviceguid
second parameter: child serviceguid
optional third parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns the relation and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceRelationSecure(parentserviceguid, childserviceguid)
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get service relations as parent

first parameter: parent serviceguid
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the parent, without checking the current user security profile

ServiceCatalogInterface.getServiceRelationsAsParent(parentserviceguid)
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get secure service relations as parent

first parameter: parent serviceguid
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the parent and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceRelationsAsParentSecure(parentserviceguid)
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get multiple service relations as parent

first parameter: array of parent serviceguids
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the parent, without checking the current user security profile

ServiceCatalogInterface.getServicesRelationsAsParent([parentserviceguid1, parentserviceguid2])
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get multiple secure service relations as parent

first parameter: array of parent serviceguids
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the parent and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServicesRelationsAsParentSecure([parentserviceguid1, parentserviceguid2])
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get service relations as child

first parameter: child serviceguid
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the child, without checking the current user security profile

ServiceCatalogInterface.getServiceRelationsAsChild(childserviceguid)
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get secure service relations as child

first parameter: child serviceguid
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the child and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceRelationsAsChildSecure(childserviceguid)
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get multiple service relations as child

first parameter: array of child serviceguids
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the child, without checking the current user security profile

ServiceCatalogInterface.getServicesRelationsAsChild([childserviceguid1, childserviceguid2])
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get multiple secure service relations as child

first parameter: array of child serviceguids
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the child and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServicesRelationsAsChildSecure([childserviceguid1, childserviceguid2])
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get service relations

first parameter: serviceguid
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the parent or child, without checking the current user security profile

ServiceCatalogInterface.getServiceRelations(serviceguid)
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get secure service relations

first parameter: serviceguid
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the parent or child and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceRelationsSecure(serviceguid)
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get multiple service relations

first parameter: array of serviceguids
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the child or the parent, without checking the current user security profile

ServiceCatalogInterface.getServicesRelations([serviceguid1, serviceguid2])
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get multiple secure service relations

first parameter: array of serviceguids
optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations where the service guid is the child or the parent and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServicesRelationsSecure([serviceguid1, serviceguid2])
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get all service relations

optional first parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations, without checking the current user security profile

ServiceCatalogInterface.getAllServicesRelations()
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Get all secure service relations

optional first parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all relations and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getAllServicesRelationsSecure()
return: the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))

Review cycles

Get service review cycles (7.22.04)

first parameter: serviceguid
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all review cycles, without checking the current user security profile

ServiceCatalogInterface.getServiceReviewCycles(guid)
return: all review cycles for the given service guid

Get secure service review cycles (7.22.04)

first parameter: serviceguid
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all review cycles and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceReviewCyclesSecure(guid)
return: all review cycles for the given service guid

Get multiple services review cycles (7.22.04)

first parameter: array with serviceguids
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all review cycles, without checking the current user security profile

ServiceCatalogInterface.getServicesReviewCycles([guid1, guid2])
return: all review cycles for the given service guids

Get secure multiple services review cycles (7.22.04)

first parameter: array with serviceguids
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all review cycles and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServicesReviewCyclesSecure([guid1, guid2])
return: all review cycles for the given service guids

Get all services review cycles (7.22.04)

optional first parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all review cycles for all services, without checking the current user security profile

ServiceCatalogInterface.getAllServicesReviewCycles()
return: all review cycles

Get secure all services review cycles (7.22.04)

optional first parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all review cycles for all services and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getAllServicesReviewCyclesSecure()
return: all review cycles

Get review cycle (7.22.04)

first parameter: reviewcycleguid
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns the review cycle, without checking the current user security profile

ServiceCatalogInterface.getReviewCycle(reviewcycleguid)
return: the review cycle

Get secure review cycles (7.22.04)

first parameter: reviewcycleguid
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns the review cycle and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getReviewCycleSecure(reviewcycleguid)
return: the review cycle

Get multiple review cycles (7.22.04)

first parameter: array with reviewcycleguids
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all review cycles, without checking the current user security profile

ServiceCatalogInterface.getReviewCycles([guid1, guid2])
return: the review cycles

Get secure multiple review cycles (7.22.04)

first parameter: array with reviewcycleguids
optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
security: Returns all review cycles and checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getReviewCyclesSecure([guid1, guid2])
return: the review cycles

Service variables

Get service variable value secure (7.22.07)

first parameter: service guid
second parameter: variable name
security: Checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceVariableValueSecure(guid, variablename)
return: the value (string)

Get service variable value (7.22.07)

first parameter: service guid
second parameter: variable name
security: No checks are done

ServiceCatalogInterface.getServiceVariableValue(guid, variablename)
return: the value (string)

Set service variable value secure (7.22.07)

first parameter: service guid
second parameter: variable name
third parameter: variable value
security: Checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.setServiceVariableValueSecure(guid, variablename, variablevalue)
return: nothing

Set service variable value (7.22.07)

first parameter: service guid
second parameter: variable name
third parameter: variable value
security: No checks are done

ServiceCatalogInterface.setServiceVariableValue(guid, variablename, variablevalue)
return: nothing

Get service variables secure (7.22.07)

first parameter: service guid
security: Checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServiceVariablesSecure(guid)
return: array of variables in JSON (properties: serviceguid, name, value)

Get service variables (7.22.07)

first parameter: service guid
security: No checks are done

ServiceCatalogInterface.getServiceVariables(guid)
return: array of variables in JSON (properties: serviceguid, name, value)

Get services variables secure (7.22.07)

first parameter: array of service guids
security: Checks if the current user is authorized to retrieve these details (at least read rights)

ServiceCatalogInterface.getServicesVariablesSecure([guid1, guid2])
return: array of variables in JSON (properties: serviceguid, name, value)

Get services variables (7.22.07)

first parameter: array of service guids
security: No checks are done

ServiceCatalogInterface.getServicesVariables([guid1, guid2])
return: array of variables in JSON (properties: serviceguid, name, value)

Get services variables (7.22.07)

first parameter: array of service guids
security: No checks are done

ServiceCatalogInterface.getServicesVariables([guid1, guid2])
return: array of variables in JSON (properties: serviceguid, name, value)

Rights

Check if the logged in person has service admin rights (7.23.03)

first parameter: service guid

ServiceCatalogInterface.loggedInPersonHasServiceAdminRights(guid)
return: true if the person has at least view rights in the admin panel for this service, false otherwise

Check if the logged in person has service admin edit rights (7.23.03)

Since 7.23.11: warning - will be removed in a future version

first parameter: service guid

ServiceCatalogInterface.loggedInPersonHasServiceAdminEditRights(guid)
return: true if the person has edit rights in the admin panel for this service, false otherwise
return since 7.23.11: always false, please use custom ACLs instead

Check if the logged in person has a service custom ACL use right (7.23.11)

first parameter: service guid
second parameter: name of the custom ACL

ServiceCatalogInterface.loggedInPersonHasServiceCustomAclUseRight(guid, name)
return: true if the person has the use right for the ACL in this service, false otherwise

Check if the logged in person has a service version custom ACL use right (7.24.10)

first parameter: service guid
second parameter: version number
thirdparameter: name of the custom ACL

ServiceCatalogInterface.loggedInPersonHasServiceVersionCustomAclUseRight(serviceguid, versionnr, name)
return: true if the person has the use right for the ACL in this service, false otherwise

FormsInterface (7.22.06)

The FormsInterface contains function that interact with request forms

WARNING: the non-secure versions of the interface behave like secure until 7.22.09

General

List categories

Returns the categories

FormsInterface.getCategories();
returns: array of objects with properties id, islive, iconurl, title, description, helptext in JSON

List categories SECURE (7.22.09)

Returns the categories based on the logged in user

FormsInterface.getCategoriesSecure();
returns: array of objects with properties id, islive, iconurl, title, description, helptext in JSON

Get category

Gets a category based on the id

first parameter: category id

FormsInterface.getCategory(1);
returns: object with properties title and topics (array of objects with properties id, islive, iconurl, title, description, helptext) in JSON

Get category SECURE (7.22.09)

Gets a category based on the id, only if the logged in user has rights for this

first parameter: category id

FormsInterface.getCategorySecure(1);
returns: object with properties islive, title and topics (array of objects with properties id, islive, iconurl, title, description, helptext) in JSON

Get topic

Gets a topic based on the id

first parameter: topic id

FormsInterface.getTopic(1);
returns: object with properties categoryid, categorytitle, categoryislive, title, islive and forms (array of objects with properties id, islive, onlyindirectlyaccessible, contenttypeid, iconurl, title, description), subnavcssclass (since 7.23.10) in JSON

Get topic SECURE (7.22.09)

Gets a topic based on the id, only if the logged in user has rights for this

first parameter: topic id

FormsInterface.getTopicSecure(1);
returns: object with properties categoryid, categorytitle, categoryislive, title, islive and forms (array of objects with properties id, islive, onlyindirectlyaccessible, contenttypeid, iconurl, title, description), subnavcssclass (since 7.23.10) in JSON

Get all topics (7.24.07)

Gets all topics

FormsInterface.getAllTopics();
returns: array of objects with properties id, islive, title, iconurl, description, helptext, subnavcssclass, categoryid in JSON

Get all topics SECURE (7.24.07)

Gets all topics where the logged in user has rights for

FormsInterface.getAllTopicsSecure();
returns: array of objects with properties id, islive, title, iconurl, description, helptext, subnavcssclass, categoryid in JSON

Get form

Gets a form based on the id

first parameter: form id

FormsInterface.getForm(1);
returns: object with properties categoryid, categorytitle, categoryislive, topicid, topictitle, topicislive, id, islive, title, description, showaddtofavorites (7.22.07), showsaveasdraft(7.22.07), showsaveastemplate(7.22.07), onlyindirectlyaccessible (7.22.10), hasadmin, isfavorite and iconurl (7.24.07) and showselectotheruser (7.24.12) in JSON

Get form SECURE (7.22.09)

Gets a form based on the id, only if the logged in user has rights for this

first parameter: form id

FormsInterface.getFormSecure(1);
returns: object with properties categoryid, categorytitle, categoryislive, topicid, topictitle, topicislive, id, islive, title, description, showaddtofavorites (7.22.07), showsaveasdraft(7.22.07), showsaveastemplate(7.22.07), onlyindirectlyaccessible (7.22.10), hasadmin, isfavorite and iconurl (7.24.07) and showselectotheruser (7.24.12) in JSON

Get favorite forms SECURE (7.22.09)

Gets the list of favorite forms

FormsInterface.getFavoriteFormsSecure();
returns: array of objects with properties categoryid, categorytitle, categoryislive, topicid, topictitle, topicislive, id, islive, title, description, showaddtofavorites (7.22.07), showsaveasdraft(7.22.07), showsaveastemplate(7.22.07), onlyindirectlyaccessible (7.22.10), hasadmin, isfavorite and iconurl (7.24.07) and showselectotheruser (7.24.12) in JSON

Remove favorite form SECURE (7.22.09)

Removes a form from the persons favorites

first parameter: id of the form

FormsInterface.removeFavoriteFormSecure(1);
returns: nothing

Add favorite form SECURE (7.22.09)

Adds a form to the persons favorites

first parameter: id of the form

FormsInterface.addFavoriteFormSecure(1);
returns: nothing

Get form instances SECURE (7.22.09)

Gets the list of form instances for the logged in user based on type/status (Draft or Template)

first parameter: the string "Draft" or "Template"

FormsInterface.getFormInstancesSecure("Draft");
returns: array of objects with properties id, extraparameters, formid, formtitle, instancetitle, dateaddedticks, dateadded in JSON

Remove form instance SECURE (7.22.09)

Removes a form instance only if the logged in user owns the form instance

first parameter: the string "Draft" or "Template"
second parameter: id of the form instance

FormsInterface.removeFormInstanceSecure("Draft", 1);
returns: nothing

Search forms and shops SECURE (7.22.09)

Returns the forms and shops based on the text

first parameter: text to search for
optional second parameter: max records to return (default = 10)

FormsInterface.searchFormsAndShopsSecure("phone");
returns: array of objects with properties id, typename, title, topictitle, categorytitle, iconurl in JSON

Search count forms (7.23.08)

Returns the number of forms that matches the criteria

first parameter: object with possible properties: isretired, internallabel, internallabeloperator, name, nameoperator
optional second parameter: object with possible property: languageid

FormsInterface.searchCountForms({ internallabel: "phone", internallabeloperator: "contains" });
returns: the number

Search count forms SECURE (7.23.08)

Returns the number of forms that matches the criteria

first parameter: object with possible properties: isretired, internallabel, internallabeloperator, name, nameoperator
optional second parameter: object with possible property: languageid

FormsInterface.searchCountFormsSecure({ internallabel: "phone", internallabeloperator: "contains" });
returns: the number

Search forms (7.23.08)

Returns the forms that matches the criteria

first parameter: object with possible properties: isretired, internallabel, internallabeloperator, name, nameoperator
optional second parameter: object with possible properties: languageid, itemsperpage, pageindex

FormsInterface.searchForms({ internallabel: "phone", internallabeloperator: "contains" });
returns: array of objects with properties id, typename, title, topictitle, categorytitle, iconurl, internallabel in JSON

Search forms SECURE (7.23.08)

Returns the forms that matches the criteria

first parameter: object with possible properties: isretired, internallabel, internallabeloperator, name, nameoperator
optional second parameter: object with possible properties: languageid, itemsperpage, pageindex

FormsInterface.searchFormsSecure({ internallabel: "phone", internallabeloperator: "contains" });
returns: array of objects with properties id, typename, title, topictitle, categorytitle, iconurl, internallabel in JSON

Remove form instance (7.22.09)

Removes a form instance

first parameter: id of the form instance

FormsInterface.removeFormInstance(1);
returns: nothing

Add form instance (7.22.09)

Adds a form instance

first parameter: form (can be the id of the form, or the internal label of the form)
second parameter: requestor person (can be the id of the person, or the unique id or email of the person)
third parameter: requested for person (can be the id of the person, or the unique id or email of the person)
fourth parameter: title of the instance
fifth parameter: array of initial form values (array of objects with possible properties displayvalue, value, internallabel, form, field, fieldid, repeatablesectionfieldid, repeatablesectionindex, label, labels (object with possible properties label, languageid, language))
optional sixth parameter: status (Draft or Template)

FormsInterface.addFormInstance("first form", "john@doe.com", "lisa@doe.com", "new draft", [ { internallabel: "first field",  value: "test" } ]);
returns: the id of the form instance

List views (7.22.10)

Returns the views

FormsInterface.getViews();
returns: array of objects with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON

List views SECURE (7.22.10)

Returns the views based on the logged in user

FormsInterface.getViewsSecure();
returns: array of objects with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON

Get view (7.22.10)

Returns the view with the id

first parameter: the id of the view

FormsInterface.getView(1);
returns: object with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON. Update since 7.23.05: extra property: fields, array of objects with properties sourcecolumn, name, fieldtypeid, fieldtypename, showindefault, showinextended, htmlencode, iskey, width, defaultsort, dateformat, filtertypeid, filtertypename, filterparametername, filterparametervaluefield, filterparameterdisplayfield

Get view SECURE (7.22.10)

Returns the view with the id only if the logged in user has rights for the view

first parameter: the id of the view

FormsInterface.getViewSecure(1);
returns: object with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON. Update since 7.23.05: extra property: fields, array of objects with properties sourcecolumn, name, fieldtypeid, fieldtypename, showindefault, showinextended, htmlencode, iskey, width, defaultsort, dateformat, filtertypeid, filtertypename, filterparametername, filterparametervaluefield, filterparameterdisplayfield

Get view by name (7.25.01)

Returns the view with the name

first parameter: the name of the view

FormsInterface.getViewByName("name");
returns: object with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON. Update since 7.23.05: extra property: fields, array of objects with properties sourcecolumn, name, fieldtypeid, fieldtypename, showindefault, showinextended, htmlencode, iskey, width, defaultsort, dateformat, filtertypeid, filtertypename, filterparametername, filterparametervaluefield, filterparameterdisplayfield

Get view by name SECURE (7.25.01)

Returns the view with the name only if the logged in user has rights for the view

first parameter: the name of the view

FormsInterface.getViewByNameSecure("name");
returns: object with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON. Update since 7.23.05: extra property: fields, array of objects with properties sourcecolumn, name, fieldtypeid, fieldtypename, showindefault, showinextended, htmlencode, iskey, width, defaultsort, dateformat, filtertypeid, filtertypename, filterparametername, filterparametervaluefield, filterparameterdisplayfield

KnowledgeManagementInterface (7.22.11)

The KnowledgeManagementInterface contains function that interact with knowledge base articles and nodes

General

Get elements by parent id

first parameter: parent id (can be null)

KnowledgeManagementInterface.getElementsByParentId(null);
returns: array of objects with properties id, parentid, contenttypeid, contenttypename, iconurl, title, description, statusid, statusname, ispublic

Get elements by parent id SECURE

first parameter: parent id (can be null)

KnowledgeManagementInterface.getElementsByParentIdSecure(null);
returns: array of objects with properties id, parentid, contenttypeid, contenttypename, iconurl, title, description, statusid, statusname, ispublic

Get element by id

first parameter: id

KnowledgeManagementInterface.getElement(1);
returns: object with properties id, parentid, contenttypeid, contenttypename, iconurl, title, description, statusid, statusname, ispublic, content, documents (array of objects with properties filename, title, link), links (array of objects with properties url, title, linktypeid, linktypename), forms (array of objects with properties id, iconurl, title, description, topicid, topictitle, categoryid, categorytitle, linktypeid, linktypename), children (array of objects with same properties as getElementsByParentId)

Get element by id SECURE

first parameter: id

KnowledgeManagementInterface.getElementSecure(1);
 returns: object with properties id, parentid, contenttypeid, contenttypename, iconurl, title, description, statusid, statusname, ispublic, content, documents (array of objects with properties filename, title, link), links (array of objects with properties url, title, linktypeid, linktypename), forms (array of objects with properties id, iconurl, title, description, topicid, topictitle, categoryid, categorytitle, linktypeid, linktypename), children (array of objects with same properties as getElementsByParentId)

Search count

Returns the number of elements based on the search criteria without checking the current logged in user

first parameter: the search term

KnowledgeManagementInterface.searchCount("test");
returns: nr of elements found

Search count SECURE

Returns the number of elements based on the search criteria where the logged in user has rights for

first parameter: the search term

KnowledgeManagementInterface.searchCountSecure("test");
returns: nr of elements found

Search

Returns the elements based on the search criteria without checking the current logged in user

first parameter: the search term
optional second parameter: object with paging info (properties: ItemsPerPage, PageIndex) - default is 10 records

KnowledgeManagementInterface.search("test");
returns: array of objects with properties elementid, title, content (part where the search term is found)

Search SECURE

Returns the elements based on the search criteria where the logged in user has rights for

first parameter: the search term
optional second parameter: object with paging info (properties: ItemsPerPage, PageIndex) - default is 10 records

KnowledgeManagementInterface.searchSecure("test");
returns: array of objects with properties elementid, title, content (part where the search term is found)

@@ Line 10: / Line 10: @@
   CommonInterface.logToConsole('message');
   ''returns'': nothing
+The logged information can be found on this url: https://yourserver/Common/Admin/JavaScriptConsole.aspx
 ==== logDebug ====
@@ Line 68: / Line 69: @@
 ==== toDate (7.22.02) ====
-#first parameter is date in string in the format yyyyMMdd or yyyyMMddHHmmss
+#first parameter is date in string in the format yyyyMMdd or yyyyMMddHHmmss or yyyyMMddHHmm (7.24.10) - input is sanitize, these characters will be removed: "-", "/", "T", ":", " " and ".0000000" (7.25.02)
   CommonInterface.toDate("20220101");
   ''returns'': a date object in the local time zone
 ==== toUtcDate (7.22.02) ====
-#first parameter is date in string in the format yyyyMMdd or yyyyMMddHHmmss
+#first parameter is date in string in the format yyyyMMdd or yyyyMMddHHmmss or yyyyMMddHHmm (7.24.10) - input is sanitize, these characters will be removed: "-", "/", "T", ":", " " and ".0000000" (7.25.02)
   CommonInterface.toUtcDate("20220101");
   ''returns'': a date object in the UTC time zone
@@ Line 80: / Line 81: @@
 #first parameter is date object in the local time zone (warning, dates created in Javascript are always UTC)
 #second parameter is the format you want the date to be in
+#optional third parameter is the culture (eg nl) since 7.24.10
   CommonInterface.dateToString(new Date(2022, 0, 1), "yyyyMMdd");
   ''returns'': the date in string in the format specified -> 20211231
@@ Line 85: / Line 87: @@
   CommonInterface.dateToString(CommonInterface.toDate("20220101"), "yyyyMMdd");
   ''returns'': the date in string in the format specified -> 20220101
+==== dateToUtcDate (7.23.04) ====
+#first parameter is date object
+ CommonInterface.dateToUtcDate(CommonInterface.toDate("20220101"));
+ ''returns'': the date object in UTC
+==== utcDateToDate (7.23.04) ====
+#first parameter is date object in UTC
+ CommonInterface.dateToUtcDate(new Date(2022, 0, 1));
+ ''returns'': the date object
 ==== utcDateToString (7.22.02) ====
 #first parameter is date object in the UTC time zone (dates created in Javascript are always UTC)
 #second parameter is the format you want the date to be in
+#optional third parameter is the culture (eg nl) since 7.24.10
   CommonInterface.utcDateToString(new Date(2022, 0, 1), "yyyyMMdd");
   ''returns'': the date in string in the format specified -> 20220101
@@ Line 108: / Line 121: @@
 #first parameter: date
 #second parameter: amount
-#third parameter: unit (bh, bd, y, year, M, month, d, day, h, hour, m, minute, s, second) bh = business hour, bd = business day
+#third parameter: unit (bh, bd, y, year, M, month, d, day, h, hour, m, minute, s, second) bh = business hour, bd = business day, since 7.24.10: bm = business minute, bs = business second
   CommonInterface.dateAdd(new Date(), -5, "h");
   ''returns'': the modified date (eg now minus 5 hours)
+==== dateDiff (7.24.10) ====
+Calculate the difference between tow dates
+#first parameter: date1
+#second parameter: date2
+#third parameter: unit (bh, bd, bm, bs, y, year, M, month, d, day, h, hour, m, minute, s, second) bh = business hour, bd = business day, bm = business minute, bs = business second
+ CommonInterface.dateDiff(date1, date2, "h");
+ ''returns'': the difference (eg 5 hours)
 ==== getSspEnvironmentName (7.22.06) ====
@@ Line 133: / Line 154: @@
   CommonInterface.getTranslationsLastReloadTicks();
   ''returns'': the date in ticks
+==== getDefaultLanguageCulture (7.23.08) ====
+Gets the culture of the default language
+ CommonInterface.getDefaultLanguageCulture();
+ ''returns'': the culture
+==== getDefaultLanguageName (7.23.08) ====
+Gets the name of the default language
+ CommonInterface.getDefaultLanguageName();
+ ''returns'': the name
+==== getDefaultLanguageId (7.23.08) ====
+Gets the id of the default language
+ CommonInterface.getDefaultLanguageId();
+ ''returns'': the id
 ==== getNewEventEntriesById (7.22.08) ====
@@ Line 147: / Line 183: @@
   CommonInterface.getNewEventEntriesByDate("2022-08-01T14:00:00");
   ''returns'': array of objects with properties id, dateadded, typename and payload JSON
+==== getCompanyName (7.24.02) ====
+Returns the name of the company as specified in the license key
+ CommonInterface.getCompanyName();
+ ''returns'': the company name
+==== getClientVersion (7.25.01) ====
+Returns the client version of the SSP installation
+ CommonInterface.getClientVersion();
+ ''returns'': the client version
+==== getTextPageDetail (7.24.07) ====
+Gets a text page by name
+#first parameter: name
+ CommonInterface.getTextPageDetail('Help');
+ ''returns'': object with properties id, name, title, content and documents (=array of objects with properties url and name) in JSON
 === Conversion ===
@@ Line 176: / Line 228: @@
 Encodes text that contains html code into encoded html so that the html code is displayed in a browser. This function can be used to avoid the execution of input strings.
 #first parameter is the string to be encoded
+#optional second parameter whether line breaks show be replaces by br tags (defaults to true) (since 7.23.02)
   CommonInterface.htmlEncode('<strong>test</strong>');
   ''returns'': &lt;strong&gt;test&lt;/strong&gt;
+==== line breaks to br tag (7.23.02) ====
+Replaces the line breaks to br tags.
+#first parameter is the string to be used
+  CommonInterface.lineBreaksToBr('test1\ntest2');
+ ''returns'': test1&lt;br /&gt;test2
 ==== htmldecode text ====
 Converts encoded html into default html
@@ Line 212: / Line 271: @@
 Convert bb-code in html formatted text, to include bb-code formatted text on web pages.
 #first parameter is the bbcode that should be converted into HTML
+#second optional parameter (since 7.24.11): object with possible key: Convert or Skip: array of types to convert or to skip (Bold, Italic, ...)
   CommonInterface.bbCodeToHtml('[b]test[/b]');
   ''returns'': <strong>test</strong>
 ==== Convert bbcode to text ====
 Convert bb-code into standard text by removing all codes
 #first parameter is the bbcode to be converted into text
+#second optional parameter (since 7.23.09): object with possible key: UseTextForLinks (value: true or false), when there's an url in the bb code, the label is used when UseTextForLinks is true - since 7.24.11: Convert or Skip: array of types to convert or to skip (Bold, Italic, ...)
   CommonInterface.bbCodeToText('[b]test[/b]');
+ ''returns'': test
+==== Convert html to text (7.23.01) ====
+Convert html into standard text by removing all codes
+#first parameter is the html to be converted into text
+ CommonInterface.convertHtmlToText('&lt;strong&gt;test&lt;/strong&gt;');
+ ''returns'': test
+==== Strip html from text (7.23.01) ====
+Remove html tags using a regular expression
+#first parameter is the html to be used
+ CommonInterface.stripHtml('&lt;strong&gt;test&lt;/strong&gt;');
   ''returns'': test
@@ Line 244: / Line 317: @@
 === File System ===
+==== Get the URL to SSP (7.23.01) ====
+Get the pubic URL to ssp
+ CommonInterface.getSspUrl();
+ ''returns'': 'https://demo.smt-x.com'
+==== Get the local URL to SSP (7.23.01) ====
+Get the pubic URL to ssp
+ CommonInterface.getSspLocalUrl();
+ ''returns'': 'https//localhost'
 ==== Check if the input is a valid path (url or local path) ====
 Checks if the provided path is valid. Returns 1 or 0
@@ Line 249: / Line 332: @@
   CommonInterface.isValidPath('http://dev.ssp7.company.com/test.txt');
   ''returns'': boolean
 ==== Check if the url starts with the url (public or local) to ssp ====
   CommonInterface.isSspFile('http://dev.ssp7.company.com/test.txt');
@@ Line 258: / Line 341: @@
   CommonInterface.getLocalPathForSspFile('http://dev.ssp7.company.com/test.txt');
   ''returns'': C:\Websites\dev.ssp7.company.com\Sql.Dev.Ssp7\test.txt
+==== Get the local root folder of the web application (7.24.12) ====
+returns the local root folder of the web application
+  CommonInterface.getLocalPathToWebRoot();
+ ''returns'': C:\Websites\dev.ssp7.company.com\Sql.Dev.Ssp7\
 ==== Get the filename of the url / local path ====
 retrieves the file name that is part of a url
@@ Line 282: / Line 370: @@
   CommonInterface.getFileContentInBase64('http://dev.ssp7.company.com/test.txt');
   ''returns'': dGVzdCBjb250ZW50
+==== Get the file content as byte array of the url / local path (since 7.23.04) ====
+  CommonInterface.getFileContentInBytes('http://dev.ssp7.company.com/test.txt');
+ ''returns'': the array of bytes
 ==== Get the file size in bytes of the url / local path ====
   CommonInterface.getFileSizeInBytes('http://dev.ssp7.company.com/test.txt');
   ''returns'': 12
 ==== Format file size in readable format (with B, KB, MB, GB or TB) ====
 Converts the provided number of bytes into a readable file size
@@ Line 298: / Line 390: @@
   CommonInterface.saveToExcel([{"name": "first value", "summary": "first summary"},{"name": "second value", "summary": "second summary"}], "Sheet1", "C:\\Temp\\Example.xlsx");
   ''returns'': nothing when success, otherwise the error message
+==== Save an object / array of objects to an Excel file and return as base64 (since 7.24.03) ====
+#parameter 1: the object / array of objects you want to save
+#parameter 2: name of the sheet in Excel
+ CommonInterface.generateExcelInBase64([{"name": "first value", "summary": "first summary"},{"name": "second value", "summary": "second summary"}], "Sheet1");
+ ''returns'': the Excel file in base64
+==== Convert Excel in base64 to JSON array (since 7.25.02) ====
+#parameter 1: the Excel file in base64
+#optional parameter 2: object with possible properties: WorksheetName, OnlyUseStringType (when true, all values will be in string)
+ CommonInterface.excelInBase64ToJson("excelinbase64");
+ ''returns'': the JSON respresentation of the Excel file
+==== Convert Excel as byte array to JSON array (since 7.25.02) ====
+#parameter 1: the Excel file as a byte array
+#optional parameter 2: object with possible properties: WorksheetName, OnlyUseStringType (when true, all values will be in string)
+ CommonInterface.excelAsByteArrayToJson([0,1,2]);
+ ''returns'': the JSON respresentation of the Excel file
+==== Convert Excel to JSON array (since 7.25.02) ====
+#parameter 1: the location to the Excel file
+#optional parameter 2: object with possible properties: WorksheetName, OnlyUseStringType (when true, all values will be in string)
+ CommonInterface.excelFileToJson("C:\\temp\\example.xlsx");
+ ''returns'': the JSON respresentation of the Excel file
+==== Get allowed upload extensions (since 7.24.10) ====
+Get the list of allowed file extensions to upload
+ CommonInterface.getAllowedUploadFileExtensions();
+ ''returns'': an array with the extensions
 ==== Execute an application (since 7.22.09) ====
@@ Line 305: / Line 426: @@
   ''returns'': as JSON encoded string of an object with properties output, error and exitcode
-=== Calling Web Services ===
+==== Save text as file (since 7.23.04) ====
-==== Get or send data to or from a webservice defined under adapters ====
+#parameter 1: the path (local or UNC, folder and file name) to save to
-#first parameter: name of webservice
+#parameter 2: the contents of the file
-#second parameter: object with key / value that is used as input fields)
+#optional parameter 3: the encoding to use
-#optional third parameter (7.23.01): object with key / value that is used as context (possible fields: name, processinstanceid, supportsretry, maxretrycount, currentretrycount, nocache, payload, istest)
+  CommonInterface.saveTextAsFile("C:\\temp\\test.txt", "test");
-changes since 7.22.10: in case the web service is not found, an error is thrown instead of returning an empty string
+  ''returns'': nothing
-  CommonInterface.callWebservice('Name of webservice', { 'field1': 'value1', 'field2': 'value2' });
-  ''returns'' in case of the webservice having a return type of single value: the single value (string)
- ''returns'' in case of the webservice having a return type of datatable or valuelist: the object encoded as a JSON string. If you want to consume it as an object in your javascript, you must use
- JSON.parse(), eg in one line: JSON.parse(CommonInterface.callWebservice('Name of webservice', { 'field1': 'value1', 'field2': 'value2' }));
-==== Get or send data to or from a webservice defined under adapters wrapped in result object (7.23.01) ====
+==== Save base64 as file (since 7.23.04) ====
-Returns the result wrapped in an object with properties result, fromcache, success, doretry, doretrynow, message, exception, data and currentretrycount
+#parameter 1: the path (local or UNC, folder and file name) to save to
-#first parameter: name of webservice
+#parameter 2: the base64 contents of the file
-#second parameter: object with key / value that is used as input fields)
+ CommonInterface.saveBase64AsFile("C:\\temp\\test.txt", "dGVzdA==");
-#optional third parameter: object with key / value that is used as context (possible fields: name, processinstanceid, supportsretry, maxretrycount, currentretrycount, nocache, payload, istest)
+  ''returns'': nothing
-  CommonInterface.callWebserviceWrapped('Name of webservice', { 'field1': 'value1', 'field2': 'value2' });
-=== Datastore parameters ===
+==== Save byte array as file (since 7.23.04) ====
+#parameter 1: the path (local or UNC, folder and file name) to save to
+#parameter 2: the byte array
+ CommonInterface.saveBytesAsFile("C:\\temp\\test.txt", [104,105]);
+ ''returns'': nothing
-==== check if user has access to datastore parameter ====
+==== Copy a file (since 7.23.04) ====
-#First parameter: name of the parameter
+#parameter 1: the path (local or UNC, folder and file name) to the source file
-  CommonInterface.loggedInPersonCanManageParameterEntries('Address Book');
+#parameter 2: the path (local or UNC, folder and file name) to save to
-  ''returns:'' boolean TRUE or FALSE if the currently logged in person has access to the parameter name provided
+#optional parameter 3: whether to overwrite the file if it exists
+ CommonInterface.copyFile("C:\\temp\\test.txt", "C:\\temp\\test2.txt");
+ ''returns'': nothing
+==== Move a file (since 7.23.04) ====
+#parameter 1: the path (local or UNC, folder and file name) to the source file
+#parameter 2: the path (local or UNC, folder and file name) to move to
+ CommonInterface.moveFile("C:\\temp\\test.txt", "C:\\temp\\test2.txt");
+ ''returns'': nothing
+==== Delete a file (since 7.23.04) ====
+#parameter 1: the path (local or UNC, folder and file name) to the file
+ CommonInterface.deleteFile("C:\\temp\\test.txt");
+ ''returns'': nothing
+==== Check if a file exists (since 7.23.04) ====
+#parameter 1: the path (local or UNC, folder and file name) to the file
+ CommonInterface.fileExists("C:\\temp\\test.txt");
+ ''returns'': true or false
+==== Create a directory (since 7.23.04) ====
+#parameter 1: the path (local or UNC) to the folder
+  CommonInterface.createDirectory("C:\\temp");
+ ''returns'': nothing
+==== Delete a directory (since 7.24.11) ====
+#parameter 1: the path (local or UNC) to the directory
+#optional parameter 2: whether to delete recursive or not (WARNING: deletes folder and all contents when true) - defaults to false
+ CommonInterface.deleteDirectory("C:\\temp");
+  ''returns'': nothing
+==== Check if a directory exists (since 7.23.04) ====
+#parameter 1: the path (local or UNC, folder and file name) to the folder
+ CommonInterface.directoryExists("C:\\temp");
+ ''returns'': true or false
+==== Get the files in a directory (since 7.23.04) ====
+#parameter 1: the path (local or UNC, folder and file name) to the folder
+ CommonInterface.getFilesInDirectory("C:\\temp");
+ ''returns'': array of file names (including the folder name)
-==== get all entries of a parameter ====
+==== Get the sub directories in a directory (since 7.23.04) ====
-#First parameter: name of the parameter
+#parameter 1: the path (local or UNC, folder and file name) to the folder
- CommonInterface.getAllParameterEntries('Address Book');
+  CommonInterface.getDirectoriesInDirectory("C:\\temp");
- ''returns:'' all the entries (array) with all the fields (properties) as JSON encoded string. If you want to consume it, use JSON.parse, eg: JSON.parse(CommonInterface.getAllParameterEntries('Address Book'));
+  ''returns'': array of sub directory names (including the folder name)
-==== get all entries of a parameter sorted on a field ====
-#First parameter: name of the parameter
-#second parameter: field to sort on
- CommonInterface.getAllParameterEntriesAndSort('Address Book', 'Name');
- ''returns'': same as above but sorted via the query
-==== Get the count of all entries of a parameter ====
-#first parameter: name of the parameter
-  CommonInterface.getAllParameterEntryCount('Address Book');
- ''returns'': 9
-==== Get specific value of a field for a specific entry ====
-#first parameter: name of the parameter
-#second parameter: key field
-#third parameter: key value
-#fourth parameter: fields to return, joined by double pipes
- CommonInterface.getParameterEntryValue('Address Book', 'Email', 'john@company.com', 'Name||Location');
-  ''returns'': the values if the requested fields for the first entry found, joined by double pipe, eg: john Doe||Maastricht
-==== Get all values of a field in a parameter ====
-#first parameter: name of the parameter
-#second parameter: field name
- CommonInterface.getParameterEntryValues('Address Book', 'Email');
- ''returns'': JSON encoded string of all the values (sorted), again to consume use JSON.parse, result: ["dasy@company.com","donald@company.com","john@company.com","example@gmail.com"]
-==== Advanced search on parameter entries ====
-#first parameter: name of the parameter
-#second parameter: object with key / value containing the predicates
- CommonInterface.searchParameterEntries('Address Book', [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'gmail.com' },{ connector: 'or', subfilter: [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'company' }, { fieldname: 'Email', filteroperator: 'notcontains', filtervalue: 'john' } ]}]);
- ''returns'': see CommonInterface.getAllParameterEntries
- for all filter operators see [[datastore filter operators|here]]
+=== Calling Web Services ===
+==== Get or send data to or from a webservice defined under adapters ====
-==== Advanced search and sort on parameter entries ====
+#first parameter: name of webservice
-#first parameter: name of the parameter
+#second parameter: object with key / value that is used as input fields)
-#second parameter: object with key / value containing the predicates
+#optional third parameter (7.23.01): object with key / value that is used as context (possible fields: name, processinstanceid, supportsretry, maxretrycount, currentretrycount, nocache, payload, istest)
-#third parameter: field to sort on
+changes since 7.22.10: in case the web service is not found, an error is thrown instead of returning an empty string
- CommonInterface.searchParameterEntriesAndSort('Address Book', [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'gmail.com' },{ connector: 'or', subfilter: [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'company' }, { fieldname: 'Email', filteroperator: 'notcontains', filtervalue: 'john' } ]}], 'Location');
+  CommonInterface.callWebservice('Name of webservice', { 'field1': 'value1', 'field2': 'value2' });
- ''returns'': same as CommonInterface.searchParameterEntries but sorted via the query
+ ''returns'' in case of the webservice having a return type of single value: the single value (string)
+  ''returns'' in case of the webservice having a return type of datatable or valuelist: the object encoded as a JSON string. If you want to consume it as an object in your javascript, you must use
-==== Get the result count of an advanced search ====
+ JSON.parse(), eg in one line: JSON.parse(CommonInterface.callWebservice('Name of webservice', { 'field1': 'value1', 'field2': 'value2' }));
-#first parameter: name of the parameter
-#second parameter: object with key / value containing the predicates
-  CommonInterface.searchParameterEntryCount('Address Book', [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'gmail.com' },{ connector: 'or', subfilter: [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'company' }, { fieldname: 'Email', filteroperator: 'notcontains', filtervalue: 'john' } ]}]);
-  ''returns'':  the number of records found
-==== Add an entry to a parameter ====
-#first parameter: name of the parameter
-#second parameter: object with key / value that contains the fields (keys) with the values (values)
- CommonInterface.addParameterEntry('Address Book', { 'Name': 'Test', 'Email': 'test@company.com' });
- ''returns'':  the new internal id of the entry
-==== Add an entry to a parameter SECURE ====
+==== Get or send data to or from a webservice defined under adapters wrapped in result object (7.23.01) ====
-#first parameter: name of the parameter
+Returns the result wrapped in an object with properties result, fromcache, success, doretry, doretrynow, message, exception, data and currentretrycount
-#second parameter: object with key / value that contains the fields (keys) with the values (values)
+#first parameter: name of webservice
-#security: This function checks if the currently logged in person is authorized to edit the parameter
+#second parameter: object with key / value that is used as input fields)
-  CommonInterface.addParameterEntrySecure('Address Book', { 'Name': 'Test', 'Email': 'test@company.com' });
+#optional third parameter: object with key / value that is used as context (possible fields: name, processinstanceid, supportsretry, maxretrycount, currentretrycount, nocache, payload, istest)
- ''returns'':  the new internal id of the entry
+  CommonInterface.callWebserviceWrapped('Name of webservice', { 'field1': 'value1', 'field2': 'value2' });
-==== updates zero or more parameter entries ====
+==== Schedule an SSP task to run on the next SSP Scheduler run  (7.23.07) ====
-#first parameter: name of the parameter
+#first parameter: name of task
-#second parameter: object with key / value that represents the predicate (filter)
+  CommonInterface.scheduleTaskToRunOnNextSchedulerRun('Import Persons');
-#third parameter: object with key / value that contains the new values (not all values are required)
-  CommonInterface.updateParameterEntries('Address Book', { 'Email': 'test@company.com' }, { 'Name': 'Test updated' });
- ''returns'':  the number of entries updated (make sure you use the correct filter, you could potentially update all the entries)
-==== updates zero or more parameter entries SECURE ====
+=== Datastore parameters ===
-#first parameter: name of the parameter
-#second parameter: object with key / value that represents the predicate (filter)
-#third parameter: object with key / value that contains the new values (not all values are required)
-#Security: This function checks if the currently logged in person is authorized to edit the parameter
- CommonInterface.updateParameterEntriesSecure('Address Book', { 'Email': 'test@company.com' }, { 'Name': 'Test updated' });
- ''returns'':  the number of entries updated (make sure you use the correct filter, you could potentially update all the entries)
-==== Delete zero or more parameter entries ====
-#first parameter: name of the parameter
-#second parameter: object with key / value that represents the predicate (filter)
- CommonInterface.deleteParameterEntries('Address Book', { 'Email': 'test@company.com' });
- ''returns'':  the number of entries deleted (make sure you use the correct filter, you could potentially delete all the entries)
-==== Delete zero or more parameter entries SECURE ====
+==== check if user has access to datastore parameter ====
-#first parameter: name of the parameter
+#First parameter: name of the parameter
-#second parameter: object with key / value that represents the predicate (filter)
+  CommonInterface.loggedInPersonCanManageParameterEntries('Address Book');
-#Security: This function checks if the currently logged in person is authorized to edit the parameter
+  ''returns:'' boolean TRUE or FALSE if the currently logged in person has access to the parameter name provided
-  CommonInterface.deleteParameterEntriesSecure('Address Book', { 'Email': 'test@company.com' });
-  ''returns'':  the number of entries deleted (make sure you use the correct filter, you could potentially delete all the entries)
-=== Person and person group (7.21.07) ===
+==== reload a datastore parameter from the source (since 7.23.07) ====
-==== getPerson ====
+#First parameter: name of the parameter
-Get person with internal id
+  CommonInterface.reloadParameter('My external parameter');
-#First parameter is internal id of the person
+  ''returns:'' nothing
-  CommonInterface.getPerson(1);
-  ''returns'': object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-==== getPersonsByEmail (acted as searchPersonsByEmail before 7.22.02) ====
+==== get all entries of a parameter ====
-Get list of people via email
+#First parameter: name of the parameter
-#First parameter is the email address
+  CommonInterface.getAllParameterEntries('Address Book');
-  CommonInterface.getPersonsByEmail("john@doe.com");
+  ''returns:'' all the entries (array) with all the fields (properties) as JSON encoded string. If you want to consume it, use JSON.parse, eg: JSON.parse(CommonInterface.getAllParameterEntries('Address Book'));
-  ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-==== getActivePersonByEmail (7.22.02) ====
+==== get all entries of a parameter sorted on a field ====
-Get active peron via email
+#First parameter: name of the parameter
-#First parameter is the email address
+#second parameter: field to sort on
-  CommonInterface.getActivePersonByEmail("john@doe.com");
+  CommonInterface.getAllParameterEntriesAndSort('Address Book', 'Name');
-  ''returns'': object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
+  ''returns'': same as above but sorted via the query
-==== searchPersonsByEmail (7.22.02) ====
+==== Get the count of all entries of a parameter ====
-Get list of people by searching via email
+#first parameter: name of the parameter
-#First parameter is the email address
+  CommonInterface.getAllParameterEntryCount('Address Book');
- CommonInterface.searchPersonsByEmail("@doe.com");
+  ''returns'': 9
- ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-==== getPersonsByUniqueId (acted as searchPersonsByUniqueId before 7.22.02)  ====
-Get list of people via uniqueid
-#First parameter is the uniqueid
-  CommonInterface.getPersonsByUniqueId("john.doe");
-  ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-==== getActivePersonByUniqueId (7.22.02) ====
+==== Get specific value of a field for a specific entry ====
-Get person via uniqueid
+#first parameter: name of the parameter
-#First parameter is the uniqueid
+#second parameter: key field
-  CommonInterface.getActivePersonByUniqueId("john.doe");
+#third parameter: key value
-  ''returns'': object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
+#fourth parameter: fields to return, joined by double pipes
+  CommonInterface.getParameterEntryValue('Address Book', 'Email', 'john@company.com', 'Name||Location');
+  ''returns'': the values if the requested fields for the first entry found, joined by double pipe, eg: john Doe||Maastricht
-==== searchPersonsByUniqueId (7.22.02) ====
+==== Get all values of a field in a parameter ====
-Get list of people by searching via uniqueid
+#first parameter: name of the parameter
-#First parameter is the uniqueid
+#second parameter: field name
-  CommonInterface.searchPersonsByUniqueId("jo");
+  CommonInterface.getParameterEntryValues('Address Book', 'Email');
-  ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
+  ''returns'': JSON encoded string of all the values (sorted), again to consume use JSON.parse, result: ["dasy@company.com","donald@company.com","john@company.com","example@gmail.com"]
+==== Get parameter entries ====
+#first parameter: name of the parameter
+#second parameter: object with key / value containing the filter
+ CommonInterface.getParameterEntries('Address Book', { Email: 'john@smt-x.com' });
+ ''returns'': see CommonInterface.getAllParameterEntries
-==== getPersonField ====
+==== Get parameter entries and sort ====
-Get the value of a person field for a specific person
+#first parameter: name of the parameter
-#First parameter is the internal id of the person
+#second parameter: object with key / value containing the filter
-#Second parameter is the name of the field (can be UniqueId, FirstName, LastName, Email or any other custom defined person field)
+#third parameter: name of the field to sort on
-  CommonInterface.getPersonField(1, "Country");
+  CommonInterface.getParameterEntriesAndSort('Address Book', { Email: 'john@smt-x.com' }, 'Name');
-  ''returns'': the value of the field
+  ''returns'': see CommonInterface.getAllParameterEntries
-==== getPersonFirstAndLastName ====
-Get the first and last name of a person
-#First parameter is the internal id of the person
- CommonInterface.getPersonFirstAndLastName(1);
- ''returns'': the first and last name
-==== getPersonDescription ====
+==== Advanced search on parameter entries ====
-Get the description of a person
+#first parameter: name of the parameter
-#First parameter is the internal id of the person
+#second parameter: array of objects containing the predicates
-  CommonInterface.getPersonDescription(1);
+  CommonInterface.searchParameterEntries('Address Book', [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'gmail.com' },{ connector: 'or', subfilter: [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'company' }, { fieldname: 'Email', filteroperator: 'notcontains', filtervalue: 'john' } ]}]);
-  ''returns'': the description in the format as defined in the settings
+  ''returns'': see CommonInterface.getAllParameterEntries
-==== getPersonGroupsForPerson ====
+  for all filter operators see [[datastore filter operators|here]]
-Get the person groups where the person is member of
-#First parameter is the internal id of the person
-  CommonInterface.getPersonGroupsForPerson(1);
- ''returns'': array of objects with properties id, name and description in JSON
-==== getPersonGroup ====
+==== Advanced search and sort on parameter entries ====
-Get the person group with internal id
+#first parameter: name of the parameter
-#First parameter is the internal id of the person group
+#second parameter: object with key / value containing the predicates
-  CommonInterface.getPersonGroup(1);
+#third parameter: field to sort on
-  ''returns'': object with properties id, name and description in JSON
+ CommonInterface.searchParameterEntriesAndSort('Address Book', [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'gmail.com' },{ connector: 'or', subfilter: [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'company' }, { fieldname: 'Email', filteroperator: 'notcontains', filtervalue: 'john' } ]}], 'Location');
+ ''returns'': same as CommonInterface.searchParameterEntries but sorted via the query
-==== getPersonGroupsByName ====
-Get a list of person groups via name
+==== Get the result count of an advanced search ====
-#First parameter is the name
+#first parameter: name of the parameter
-  CommonInterface.getPersonGroupsByName("Groupname");
+#second parameter: object with key / value containing the predicates
-  ''returns'': array of objects with properties id, name and description in JSON
+  CommonInterface.searchParameterEntryCount('Address Book', [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'gmail.com' },{ connector: 'or', subfilter: [{ fieldname: 'Email', filteroperator: 'contains', filtervalue: 'company' }, { fieldname: 'Email', filteroperator: 'notcontains', filtervalue: 'john' } ]}]);
+  ''returns'':  the number of records found
+==== Add an entry to a parameter ====
+#first parameter: name of the parameter
+#second parameter: object with key / value that contains the fields (keys) with the values (values)
+  CommonInterface.addParameterEntry('Address Book', { 'Name': 'Test', 'Email': 'test@company.com' });
+  ''returns'':  the new internal id of the entry
+ Example:
+ var field1 = #REPLACE-FORMFIELD-ABC#;
+ var field2 = #REPLACE-FORMFIELD-DEF#;
+ CommonInterface.addParameterEntry('Address Book', {
+    columnname1 : field1,
+    columnname2 : field2
+ });
-==== getPersonsForPersonGroup ====
+==== Add an entry to a parameter SECURE ====
-Get the members of the person group
+#first parameter: name of the parameter
-#First parameter is the internal id of the person group
+#second parameter: object with key / value that contains the fields (keys) with the values (values)
-  CommonInterface.getPersonsForPersonGroup(1);
+#security: This function checks if the currently logged in person is authorized to edit the parameter
-  ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
+  CommonInterface.addParameterEntrySecure('Address Book', { 'Name': 'Test', 'Email': 'test@company.com' });
+  ''returns'':  the new internal id of the entry
-==== searchPersons (7.22.06) ====
+==== Add multiple entries to a parameter (since 7.23.07) ====
-Search for people
+#first parameter: name of the parameter
-#first parameter is text you wish to search for
+#second parameter: array of objects with key / value that contains the fields (keys) with the values (values)
-#optional second parameter is the number of records you'd like to receive (default is 50)
+  CommonInterface.addParameterEntries('Address Book', [{ 'Name': 'Test1', 'Email': 'test1@company.com' }, { 'Name': 'Test2', 'Email': 'test2@company.com' }]);
-  CommonInterface.searchPersons("john");
+  ''returns'':  array of the new internal ids for the entries
-  ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-=== Global messages (7.22.06) ===
+==== Add multiple entries to a parameter SECURE (since 7.23.07) ====
-==== getGlobalMessages ====
+#first parameter: name of the parameter
-Get the active global messages
+#second parameter: array of objects with key / value that contains the fields (keys) with the values (values)
-  CommonInterface.getGlobalMessages();
+#security: This function checks if the currently logged in person is authorized to edit the parameter
-  ''returns'': array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON
+ CommonInterface.addParameterEntriesSecure('Address Book', [{ 'Name': 'Test1', 'Email': 'test1@company.com' }, { 'Name': 'Test2', 'Email': 'test2@company.com' }]);
+ ''returns'':  array of the new internal ids for the entries
+==== updates zero or more parameter entries ====
+#first parameter: name of the parameter
+#second parameter: object with key / value that represents the predicate (filter)
+#third parameter: object with key / value that contains the new values (not all values are required)
+  CommonInterface.updateParameterEntries('Address Book', { 'Email': 'test@company.com' }, { 'Name': 'Test updated' });
+  ''returns'':  the number of entries updated (make sure you use the correct filter, you could potentially update all the entries)
-==== getGlobalMessages SECURE (7.22.12) ====
+==== updates zero or more parameter entries SECURE ====
-Get the active global messages for the logged in user
+#first parameter: name of the parameter
-  CommonInterface.getGlobalMessagesSecure();
+#second parameter: object with key / value that represents the predicate (filter)
-  ''returns'': array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON
+#third parameter: object with key / value that contains the new values (not all values are required)
+#Security: This function checks if the currently logged in person is authorized to edit the parameter
+  CommonInterface.updateParameterEntriesSecure('Address Book', { 'Email': 'test@company.com' }, { 'Name': 'Test updated' });
+  ''returns'':  the number of entries updated (make sure you use the correct filter, you could potentially update all the entries)
+==== Delete zero or more parameter entries ====
+#first parameter: name of the parameter
+#second parameter: object with key / value that represents the predicate (filter)
+ CommonInterface.deleteParameterEntries('Address Book', { 'Email': 'test@company.com' });
+ ''returns'':  the number of entries deleted (make sure you use the correct filter, you could potentially delete all the entries)
-==== getGlobalMessages expired (7.22.12) ====
+==== Delete zero or more parameter entries SECURE ====
-Get the expired global messages
+#first parameter: name of the parameter
-  CommonInterface.getExpiredGlobalMessages();
+#second parameter: object with key / value that represents the predicate (filter)
-  ''returns'': array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON
+#Security: This function checks if the currently logged in person is authorized to edit the parameter
+  CommonInterface.deleteParameterEntriesSecure('Address Book', { 'Email': 'test@company.com' });
+  ''returns'':  the number of entries deleted (make sure you use the correct filter, you could potentially delete all the entries)
-==== getGlobalMessages expired SECURE (7.22.12) ====
+==== Delete all parameter entries (since 7.23.07) ====
-Get the expired global messages for the logged in user
+#first parameter: name of the parameter
-  CommonInterface.getExpiredGlobalMessagesSecure();
+  CommonInterface.deleteAllParameterEntries('Address Book');
-  ''returns'': array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON
+  ''returns'':  the number of entries deleted
-==== markGlobalMessageAsSeen ====
+==== Delete all parameter entries SECURE (since 7.23.07) ====
-Marks a global message as seen for the logged in account
+#first parameter: name of the parameter
-#first parameter is the id of the message
+#Security: This function checks if the currently logged in person is authorized to edit the parameter
-  CommonInterface.markGlobalMessageAsSeen(1);
+  CommonInterface.deleteAllParameterEntriesSecure('Address Book');
-  ''returns'': nothing
+  ''returns'':  the number of entries deleted
-=== Navigation items (7.22.10) ===
+=== Person and person group (7.21.07) ===
-==== Get navigation items ====
+==== getPerson ====
-Get all the navigation items
+Get person with internal id
-  CommonInterface.getNavigationItems();
+#First parameter is internal id of the person
-  ''returns'': array of object with properties id, name, typeid, typename, url, showinbox, showatbottom and boxcssclass in JSON
+  CommonInterface.getPerson(1);
+  ''returns'': object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-==== Get navigation items SECURE ====
+==== getPersons (7.23.08) ====
-Get all the navigation items based on the logged in user
+Get persons with internal id
-  CommonInterface.getNavigationItemsSecure();
+#First parameter is an array with internal id of the persons
-  ''returns'': array of object with properties id, name, typeid, typename, url, showinbox, showatbottom and boxcssclass in JSON
+  CommonInterface.getPersons([1,2]);
+  ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-== WorkflowInterface ==
+==== getPersonsByEmail (acted as searchPersonsByEmail before 7.22.02) ====
-The WorkflowInterface contains function that interact with tickets
+Get list of people via email
+#First parameter is the email address
+ CommonInterface.getPersonsByEmail("john@doe.com");
+ ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
+==== getActivePersonByEmail (7.22.02) ====
+Get active peron via email
+#First parameter is the email address
+ CommonInterface.getActivePersonByEmail("john@doe.com");
+ ''returns'': object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
+==== searchPersonsByEmail (7.22.02) ====
+Get list of people by searching via email
+#First parameter is the email address
+ CommonInterface.searchPersonsByEmail("@doe.com");
+ ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-=== General ===
+==== getPersonsByUniqueId (acted as searchPersonsByUniqueId before 7.22.02)  ====
-==== Check if a ticket id exists (7.21.07) ====
+Get list of people via uniqueid
-#first parameter: ticket id
+#First parameter is the uniqueid
-  WorkflowInterface.processInstanceIdExists(1500);
+ CommonInterface.getPersonsByUniqueId("john.doe");
-  ''returns'': true or false
+ ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
+==== getActivePersonByUniqueId (7.22.02) ====
+Get person via uniqueid
+#First parameter is the uniqueid
+ CommonInterface.getActivePersonByUniqueId("john.doe");
+ ''returns'': object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
+==== searchPersonsByUniqueId (7.22.02) ====
+Get list of people by searching via uniqueid
+#First parameter is the uniqueid
+ CommonInterface.searchPersonsByUniqueId("jo");
+ ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
+==== getPersonsByFilter (7.24.11) ====
+Search for persons using a filter
+#first parameter: a filter object or an array of filter objects
+#optional second parameter: an object with paging information
+  CommonInterface.getPersonsByFilter([{IsActive: true}, { Connector: "OR", FieldName: "Email", FilterValue: "smt-x.com", Operator: "EndsWith" }]);
+  ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-==== Remove process instance object from thread cache (7.21.07) ====
+==== reloadPersonData (7.23.07) ====
-For performance reasons, the process instance object will be cached per request, if you edit the object and request data after the action you may need to clear the cache first. Use this only when you are sure you need this.
+Reloads the persons data
-#first parameter: ticket id
+#First parameter is the id of the person
-  WorkflowInterface.removeProcessInstanceFromThreadCache(1500);
+  CommonInterface.reloadPersonData(1);
   ''returns'': nothing
-==== Check if process instance is still submitting (7.22.07) ====
+==== getPersonDetail (7.23.07) ====
-#first parameter: ticket id
+Gets the detail of a person, including the person extra fields
-  WorkflowInterface.processInstanceIsStillSubmitting(1500);
+#First parameter is the id of the person
-  ''returns'': true or false
+#Optional second parameter is a boolean whether to reload the persons data first
+  CommonInterface.getPersonDetail(1, true);
+  ''returns'': object with properties id, firstname, lastname, email, uniqueid, description, inactive, fields (array of objects with properties name and value) in JSON
-==== Check if process instance is closed (7.22.09) ====
+==== getPersonField ====
-#first parameter: ticket id
+Get the value of a person field for a specific person
-  WorkflowInterface.processInstanceIsClosed(1500);
+#First parameter is the internal id of the person
-  ''returns'': true or false
+#Second parameter is the name of the field (can be UniqueId, FirstName, LastName, Email or any other custom defined person field)
+  CommonInterface.getPersonField(1, "Country");
+  ''returns'': the value of the field
-==== Evaluate replace placeholders (7.22.07) ====
+==== getPersonFirstAndLastName ====
-Evaluates the replace placeholders in the specified text
+Get the first and last name of a person
-#first parameter: ticket id
+#First parameter is the internal id of the person
-#second parameter: the text containing the replace placeholders
+  CommonInterface.getPersonFirstAndLastName(1);
-#optional third parameter: object with optional properties IsInHtml, UseLoggedInAccount, UseCurrentLanguage, LanguageId
+  ''returns'': the first and last name
-  WorkflowInterface.evaluateReplacePlaceholders(1500, "#REPLACE-STEP-PROCESS-Guid#");
-  ''returns'': the evaluated value
-==== Do check wait steps (7.22.09) ====
+==== getPersonDescription ====
-Evaluates the open wait steps in a ticket
+Get the description of a person
-#first parameter: ticket id
+#First parameter is the internal id of the person
-  WorkflowInterface.doCheckWaitSteps(1500);
+  CommonInterface.getPersonDescription(1);
-  ''returns'': nothing (this executes in a separate thread, so it does not wait until the wait step checks are done)
+  ''returns'': the description in the format as defined in the settings
-==== Get workflow information for a ticket (7.21.07) ====
+==== getPersonGroupsForPerson ====
-#first parameter: ticket id
+Get the person groups where the person is member of (before 7.24.05: only active ones + where person is member or manager)
-  WorkflowInterface.getWorkflowInformation(1500);
+#First parameter is the internal id of the person
-  ''returns'': object with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), formid, forminstanceid, externalappname, name, processname, formname, isarchived and pool (object with properties id and name) and ticketnr (7.22.06 - contains customkey) in JSON
+  CommonInterface.getPersonGroupsForPerson(1);
+  ''returns'': array of objects with properties id, name, description, inactive (7.24.05) in JSON
-==== Search workflow tickets count (7.22.06) ====
+==== getPersonGroupsAsManagerForPerson (7.24.05) ====
-Returns the number of tickets based on the search criteria without checking the current logged in user
+Get the person groups where the person is manager of
-#first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)
+#First parameter is the internal id of the person
-  WorkflowInterface.searchCountWorkflowTickets({"Status": "Open"});
+  CommonInterface.getPersonGroupsAsManagerForPerson(1);
-  ''returns'': nr of tickets
+  ''returns'': array of objects with properties id, name, description, inactive (7.24.05) in JSON
-==== Search workflow tickets count SECURE (7.22.06) ====
+==== getPersonGroupsAsManagerOrMemberForPerson (7.24.05) ====
-Returns the number of tickets based on the search criteria where the logged in user has rights for
+Get the person groups where the person is manager or member of
-#first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)
+#First parameter is the internal id of the person
-  WorkflowInterface.searchCountWorkflowTicketsSecure({"Status": "Open"});
+  CommonInterface.getPersonGroupsAsManagerOrMemberForPerson(1);
-  ''returns'': nr of tickets
+  ''returns'': array of objects with properties id, name, description, inactive (7.24.05) in JSON
-==== Search workflow tickets (7.22.06) ====
+==== getPersonGroup ====
-Returns the tickets based on the search criteria without checking the current logged in user
+Get the person group with internal id
-#first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)
+#First parameter is the internal id of the person group
-#optional second parameter: object with paging info (properties: ItemsPerPage, PageIndex) - default is 10 records
+  CommonInterface.getPersonGroup(1);
-  WorkflowInterface.searchWorkflowTickets({"Status": "Open"});
+  ''returns'': object with properties id, name and description in JSON
-  ''returns'': array of objects with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), formid, forminstanceid, externalappname, name, processname, formname, isarchived and pool (object with properties id and name) and ticketnr (7.22.06 - contains customkey) in JSON
-==== Search workflow tickets SECURE (7.22.06) ====
+==== getPersonGroupsByName ====
-Returns the tickets based on the search criteria where the logged in user has rights for
+Get a list of person groups via name
-#first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)
+#First parameter is the name
-#optional second parameter: object with paging info (properties: ItemsPerPage, PageIndex) - default is 10 records
+  CommonInterface.getPersonGroupsByName("Groupname");
-  WorkflowInterface.searchWorkflowTicketsSecure({"Status": "Open"});
+  ''returns'': array of objects with properties id, name and description in JSON
-  ''returns'': array of object with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), formid, forminstanceid, externalappname, name, processname, formname, isarchived and pool (object with properties id and name) and ticketnr (7.22.06 - contains customkey) in JSON
-==== Get ticketing information for a ticket (7.21.07) ====
+==== getPersonGroupsByFilter (7.24.11) ====
-#first parameter: ticket id
+Search for person groups using a filter
-  WorkflowInterface.getTicketInformation(1500);
+#first parameter: a filter object or an array of filter objects
-  ''returns'': object with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), islocked, isrunning, tickettype, tasktype, requestedforteam, pool (object with properties id and name), medium (object with properties code and name), priority (object with properties code and name), status (object with properties code and name), service (object with properties code and name), category (object with properties code and name), classification (object with properties code and name), closurecode (object with properties code and name), description, information, solution, solutionlinkalldocuments, solutiondocumentkeys (array of keys in string), plannedeliverydate, deadlinedate, requestedforalternatename, requestedforalternateemail, requestedforalternatetelephone, assignedtoperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtopersongroup (object with properties id, name and description), customfields (array of objects with properties name, typeid, typename, ishidden, parametername, parametervaluefield, parameterdisplayfield, stringvalue and datetimevalue) in JSON
+#optional second parameter: an object with paging information
+  CommonInterface.getPersonGroupsByFilter([{IsActive: true}, { Connector: "OR", FieldName: "Name", FilterValue: "test", Operator: "Contains" }]);
+  ''returns'': array of objects with properties id, name, description and inactive in JSON
-==== Start a new process instance (7.21.12) ====
+==== addPersonToPersonGroup (7.23.03) ====
-#first parameter: process (id or name)
+Adds a person to a person group
-#second parameter: requestor person (id or unique id or email)
+#first parameter is the internal id of the person group
-#third parameter: requested for person (id or unique id or email)
+#second parameter is the internal id of the person
-#fourth parameter: external app name
+#optional third parameter is whether the person wants to receive the mails via the group
-#fifth parameter: array of form field objects, each object can have the properties displayvalue, value, internallabel, label and labels (array of objects with properties label and language)
+ CommonInterface.addPersonToPersonGroup(1, 1);
+ ''returns'': true if there were changes, false otherwise
-  WorkflowInterface.startProcessInstance("My test process", "John.Doe", "John.Doe", "my test app", [{ internallabel: "field1", value: "value 1", labels: [{ label: "field 1", language: "English" }, { label: "veld 1", language: "Nederlands" }] }, { value: "value 2", displayvalue: "dis val 2", label: "field 2" }]);
+==== setPersonsInPersonGroup (7.23.03) ====
-  ''returns'': object with properties id and guid in JSON
+Sets the list of persons in a person group
+#first parameter is the internal id of the person group
+#second parameter is an array with internal ids of the persons
+#optional third parameter is whether the persons want to receive the mails via the group
+  CommonInterface.setPersonsInPersonGroup(1, [1, 2, 3], false);
+  ''returns'': true if there were changes, false otherwise
-==== Start a new process instance with passing thru initial ticketing data (7.21.12) ====
+==== removePersonFromPersonGroup (7.23.03) ====
-#first parameter: process (id or name)
+Removes a person from a person group
-#second parameter: requestor person (id or unique id or email)
+#first parameter is the internal id of the person group
-#third parameter: requested for person (id or unique id or email)
+#second parameter is the internal id of the person
-#fourth parameter: external app name
+ CommonInterface.removePersonFromPersonGroup(1, 1);
-#fifth parameter: array of form field objects, each object can have the properties displayvalue, value, internallabel, label and labels (array of objects with properties label and language)
+ ''returns'': true if there were changes, false otherwise
-#sixth parameter: object with initial ticketing data, possible properties are assignedtoperson, assignedtopersongroup, category, classification, closurecode, deadlinedate, description, information, initialtasksfield, medium, planneddeliverydate, pool, priority, requestedfor, requestedforalternateemail, requestedforalternatename, requestedforalternatetelephone, requestedforteam, service, solution, status and customfields (array of objects with properties fieldname and stringvalue)
-  WorkflowInterface.startProcessInstanceWithTicketData("My test process", "John.Doe", "John.Doe", "my test app", [{ internallabel: "field1", value: "value 1", labels: [{ label: "field 1", language: "English" }, { label: "veld 1", language: "Nederlands" }] }, { value: "value 2", displayvalue: "dis val 2", label: "field 2" }], { status: "New", assignedtopersongroup: "My first group", assignedtoperson: "John.Doe", "Description": "test", customfields: [{fieldname: "customfield1", stringvalue: "custom field value"}] });
+==== getPersonsForPersonGroup ====
-  ''returns'': object with properties id and guid in JSON
+Get the members of the person group
+#First parameter is the internal id of the person group
+  CommonInterface.getPersonsForPersonGroup(1);
+  ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-=== Rights (7.21.07) ===
+==== searchPersons (7.22.06) ====
-==== Check if the logged in person has workflow admin rights on the ticket ====
+Search for people
-#first parameter: ticket id
+#first parameter is text you wish to search for
-  WorkflowInterface.loggedInPersonHasWorkflowAdminRight(1500);
+#optional second parameter is the number of records you'd like to receive (default is 50)
-  ''returns'': true or false
+  CommonInterface.searchPersons("john");
+  ''returns'': array of objects with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-==== Check if the logged in person has workflow power user rights on the ticket ====
+=== Global messages (7.22.06) ===
-#first parameter: ticket id
+==== getGlobalMessages ====
-  WorkflowInterface.loggedInPersonHasWorkflowPowerUserRight(1500);
+Get the active global messages
-  ''returns'': true or false
+  CommonInterface.getGlobalMessages();
+  ''returns'': array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON
-==== Check if the logged in person has workflow read rights on the ticket ====
+==== getGlobalMessages SECURE (7.22.12) ====
-#first parameter: ticket id
+Get the active global messages for the logged in user
-  WorkflowInterface.loggedInPersonHasWorkflowReadRight(1500);
+  CommonInterface.getGlobalMessagesSecure();
-  ''returns'': true or false
+  ''returns'': array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON
-==== Check if the logged in person has workflow write rights on the ticket ====
+==== getGlobalMessages expired (7.22.12) ====
-#first parameter: ticket id
+Get the expired global messages
-  WorkflowInterface.loggedInPersonHasWorkflowWriteRight(1500);
+  CommonInterface.getExpiredGlobalMessages();
-  ''returns'': true or false
+  ''returns'': array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON
-==== Check if the logged in person has ticketing limited rights on the ticket ====
+==== getGlobalMessages expired SECURE (7.22.12) ====
-#first parameter: ticket id
+Get the expired global messages for the logged in user
-  WorkflowInterface.loggedInPersonHasTicketLimitedRight(1500);
+  CommonInterface.getExpiredGlobalMessagesSecure();
-  ''returns'': true or false
+  ''returns'': array of object with properties id, ontop, unread, fromdateticks, fromdate, subject, shortdescription and body + since 7.22.12: isurgent, todateticks, todate, categories in JSON
-==== Check if the logged in person has ticketing read rights on the ticket ====
+==== markGlobalMessageAsSeen ====
-#first parameter: ticket id
+Marks a global message as seen for the logged in account
-  WorkflowInterface.loggedInPersonHasTicketReadRight(1500);
+#first parameter is the id of the message
-  ''returns'': true or false
+  CommonInterface.markGlobalMessageAsSeen(1);
+  ''returns'': nothing
-==== Check if the logged in person has ticketing write rights on the ticket ====
+=== Navigation items (7.22.10) ===
-#first parameter: ticket id
+==== Get navigation items ====
-  WorkflowInterface.loggedInPersonHasTicketWriteRight(1500);
+Get all the navigation items
-  ''returns'': true or false
+ CommonInterface.getNavigationItems();
+ ''returns'': array of object with properties id, name, typeid, typename, url, showinbox, showatbottom and boxcssclass in JSON
+==== Get navigation items SECURE ====
+Get all the navigation items based on the logged in user
+ CommonInterface.getNavigationItemsSecure();
+ ''returns'': array of object with properties id, name, typeid, typename, url, showinbox, showatbottom and boxcssclass in JSON
+== WorkflowInterface ==
+The WorkflowInterface contains function that interact with tickets
+=== Processes ===
+==== Search count processes (7.23.08) ====
+Returns the number of processes that matches the criteria
+#first parameter: object with possible properties: isretired, text, name, nameoperator
+#optional second parameter: object with possible property: languageid
+ WorkflowInterface.searchCountProcesses({ name: "phone", nameoperator: "contains" });
+ ''returns'': the number
+==== Search count processes SECURE (7.23.08) ====
+Returns the number of processes that matches the criteria
+#first parameter: object with possible properties: isretired, text, name, nameoperator
+#optional second parameter: object with possible property: languageid
+ WorkflowInterface.searchCountProcessesSecure({ internallabel: "phone", internallabeloperator: "contains" });
+ ''returns'': the number
+==== Search processes (7.23.08) ====
+Returns the processes that matches the criteria
+#first parameter: object with possible properties: isretired, text, name, nameoperator
+#optional second parameter: object with possible properties: languageid, itemsperpage, pageindex
+ WorkflowInterface.searchProcesses({ internallabel: "phone", internallabeloperator: "contains" });
+ ''returns'': array of objects with properties id, title, description in JSON
+==== Search processes SECURE (7.23.08) ====
+Returns the processes that matches the criteria
+#first parameter: object with possible properties: isretired, text, name, nameoperator
+#optional second parameter: object with possible properties: languageid, itemsperpage, pageindex
+  WorkflowInterface.searchProcessesSecure({ internallabel: "phone", internallabeloperator: "contains" });
+  ''returns'': array of objects with properties id, title, description in JSON
-==== Check if the logged in person has write rights on the task (no checks on ticket are done) ====
+=== General ===
-#first parameter: task id
+==== Check if a ticket id exists (7.21.07) ====
-  WorkflowInterface.loggedInPersonHasTaskWriteRight(100);
+#first parameter: ticket id
+  WorkflowInterface.processInstanceIdExists(1500);
   ''returns'': true or false
-=== Variables ===
+==== Remove process instance object from thread cache (7.21.07) ====
-==== Get the value of a variable in a ticket ====
+For performance reasons, the process instance object will be cached per request, if you edit the object and request data after the action you may need to clear the cache first. Use this only when you are sure you need this.
 #first parameter: ticket id
-#second parameter: name of the variable
+  WorkflowInterface.removeProcessInstanceFromThreadCache(1500);
-  WorkflowInterface.getVariableValue(1500, 'My variable');
+  ''returns'': nothing
-  ''returns'': the value as string
+==== Check if process instance is still submitting (7.22.07) ====
-==== sets the value of a variable in a ticket (if it doesn't exists, it will be created) ====
 #first parameter: ticket id
-#second parameter: name of the variable
+  WorkflowInterface.processInstanceIsStillSubmitting(1500);
-#third parameter: value of the variable
+  ''returns'': true or false
-  WorkflowInterface.setVariableValue(1500, 'My variable', 'new value');
-  ''returns'': nothing
-=== Form Values ===
+==== Check if process instance is closed (7.22.09) ====
-==== Get all form fields for a ticket (7.21.07) ====
 #first parameter: ticket id
-  WorkflowInterface.getAllFormFields(1500);
+  WorkflowInterface.processInstanceIsClosed(1500);
-  ''returns'': array of objects with properties fieldorder, fieldtypeid, fieldtypename, internalname, label, helptext, subfielddefinition, parametername, value (object depending on the fieldtype), rawvalue, displayvalue, visible, htmlencode, repeatablesectionindex, repeatablesectionfieldid in JSON
+  ''returns'': true or false
-==== Get raw value of a form field in a ticket ====
+==== Evaluate replace placeholders (7.22.07) ====
+Evaluates the replace placeholders in the specified text
 #first parameter: ticket id
-#second parameter: internal name of the form field
+#second parameter: the text containing the replace placeholders
- WorkflowInterface.getFormFieldValue(1500, 'MyFormField');
+#optional third parameter: object with optional properties IsInHtml, UseLoggedInAccount, UseCurrentLanguage, LanguageId
- ''returns'': the value as string
+  WorkflowInterface.evaluateReplacePlaceholders(1500, "#REPLACE-STEP-PROCESS-Guid#");
+  ''returns'': the evaluated value
-==== Get raw displayvalue of a form field in a ticket ====
-#first parameter: ticket id
-#second parameter: internal name of the form field
-  WorkflowInterface.getFormFieldDisplayValue(1500, 'MyFormField');
-  ''returns'': the display value as string
-==== Get the value definition of a form field in a ticket (for selection fields) ====
+==== Do check wait steps (7.22.09) ====
+Evaluates the open wait steps in a ticket
 #first parameter: ticket id
-#second parameter: internal name of the form field
+  WorkflowInterface.doCheckWaitSteps(1500);
-  WorkflowInterface.getFormFieldSubFieldDefinition(1500, 'MyFormField');
+  ''returns'': nothing (this executes in a separate thread, so it does not wait until the wait step checks are done)
-  ''returns'': the definition (eg: Name||Email)
-==== Get the sub value of a form field in a ticket (for selection fields) ====
+==== Do resume from here (7.23.01) ====
+Restarts a process instance from a certain step
 #first parameter: ticket id
-#second parameter: internal name of the form field
+#second parameter: processinstancestepid
-#third parameter: name of the sub field
+#third parameter: actor name
-  WorkflowInterface.getFormSubFieldValue(1500, 'MyFormField', 'Name');
+#forth parameter: whether to remove the previous instances
-  ''returns'': the value as string (eg: Raymond)
+  WorkflowInterface.doResumeFromProcessInstanceStep(1500, 1800, "SYSTEM", false);
+  ''returns'': nothing (this executes in a separate thread)
-==== Get the list of sub value of a form field in a ticket (for selection fields with multiple values) ====
+==== Do retry from here (7.23.01) ====
+Retries a process instance step (in case it can be retried)
 #first parameter: ticket id
-#second parameter: internal name of the form field
+#second parameter: instance step id
-#third parameter: name of the sub field
+#third parameter: actor name
-  WorkflowInterface.getFormSubFieldValues(1500, 'MyFormField', 'Name');
+  WorkflowInterface.doRetryProcessInstanceStep(1500, 1800, "SYSTEM");
-  ''returns'': the values as string array in JSON (eg: ["Dominic", "Raymond"])
+  ''returns'': nothing (this executes in a separate thread)
-==== Get an object (key/value) where key is the sub field name and value the selected values of a form field in a ticket (for selection fields with single value) ====
+==== Stop process instance (7.24.10) ====
+Stops a process instance without checking the rights
 #first parameter: ticket id
-#second parameter: internal name of the form field
+#optional second parameter: the actor name
-  WorkflowInterface.getFormFieldSelectionValue(1500, 'MyFormField');
+#optional third parameter: the actor person id
-  ''returns'': object in JSON (eg: {"Name": "Raymond", "Email": "raymond@smt-x.com"})
+  WorkflowInterface.stopProcessInstance(1500);
+  ''returns'': nothing
-==== Get a list of objects (key/value) where key is the sub field name and value the selected values of a form field in a ticket (for selection fields with multiple values) ====
+==== Stop process instance secure (7.24.10) ====
+Stops a process instance if the logged in person has the rights to do this
 #first parameter: ticket id
-#second parameter: internal name of the form field
+#optional second parameter: the actor name
-  WorkflowInterface.getFormFieldSelectionValues(1500, 'MyFormField');
+#optional third parameter: the actor person id
-  ''returns'': array of objects in JSON (eg: [{"Name": "Raymond", "Email": "raymond@smt-x.com"},{"Name": "Dominic", "Email": "dominic@smt-x.com"}])
+  WorkflowInterface.stopProcessInstanceSecure(1500);
+  ''returns'': nothing
-=== Open actions ===
+==== Get workflow information for a ticket (7.21.07) ====
-==== Get the open (step) actions in a ticket ====
 #first parameter: ticket id
-  WorkflowInterface.getOpenActions(1500);
+  WorkflowInterface.getWorkflowInformation(1500);
-  ''returns'': array of open actions in JSON (properties: stepname, stepinformation, link, array of actors (person), messagesfunctionid, allowsubmit, typeid, pisiaid, pisianame, submithash, array of fields (properties: id, name, typeid, required, stringvalue, displaystringvalue, datetimevalue, pdbname, pdbvaluefieldname, pdbtextfieldname, pdbhashcheck, rows, regex, helptext))
+  ''returns'': object with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), formid, forminstanceid, externalappname, name, processname, formname, isarchived and pool (object with properties id and name) and ticketnr (7.22.06 - contains customkey) in JSON
-=== Logging ===
-==== Get all logs for a ticket (7.21.07) ====
-Get a list with all logs, including workflow logs, private notes, public messages and ticket changes
-#first parameter: ticket id
- WorkflowInterface.getAllLogs(1500);
- ''returns'': array of objects with properties date, person (object with properties id, firstname, lastname, email, uniqueid, description and inactive), text, typeid, typename, notified (array of names), documentkeys (array of keys in string) in JSON
-==== Get workflow logs for a ticket (7.21.07) ====
+==== Search workflow tickets count (7.22.06) ====
-Get a list of only workflow logs
+Returns the number of tickets based on the search criteria without checking the current logged in user
-#first parameter: ticket id
+#first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)
-  WorkflowInterface.getWorkflowLogs(1500);
+  WorkflowInterface.searchCountWorkflowTickets({"Status": "Open"});
-  ''returns'': array of objects with properties date, person (object with properties id, firstname, lastname, email, uniqueid, description and inactive), text, typeid, typename, notified (array of names), documentkeys (array of keys in string) in JSON
+  ''returns'': nr of tickets
-==== Add a log to the process instance (workflow log) ====
+==== Search workflow tickets count SECURE (7.22.06) ====
-#first parameter: ticket id
+Returns the number of tickets based on the search criteria where the logged in user has rights for
-#second parameter: the log text
+#first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)
-  WorkflowInterface.addWorkflowLog(1500, 'My log text');
+ WorkflowInterface.searchCountWorkflowTicketsSecure({"Status": "Open"});
-  ''returns'': nothing
+ ''returns'': nr of tickets
+==== Search workflow tickets (7.22.06) ====
+Returns the tickets based on the search criteria without checking the current logged in user
+#first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)
+#optional second parameter: object with paging info (properties: ItemsPerPage, PageIndex) - default is 10 records
+  WorkflowInterface.searchWorkflowTickets({"Status": "Open"});
+ ''returns'': array of objects with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), formid, forminstanceid, externalappname, name, processname, formname, isarchived and pool (object with properties id and name) and ticketnr (7.22.06 - contains customkey) in JSON
+==== Search workflow tickets SECURE (7.22.06) ====
+Returns the tickets based on the search criteria where the logged in user has rights for
+#first parameter: object with search criteria (possible properties: LanguageId, CustomKey, Id, Status, Keywords, RequestorId, DateStartedFrom, DateStartedTo, DateEndedFrom, DateEndedTo)
+#optional second parameter: object with paging info (properties: ItemsPerPage, PageIndex) - default is 10 records
+ WorkflowInterface.searchWorkflowTicketsSecure({"Status": "Open"});
+  ''returns'': array of object with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), formid, forminstanceid, externalappname, name, processname, formname, isarchived and pool (object with properties id and name) and ticketnr (7.22.06 - contains customkey) in JSON
-=== Attachments ===
+==== Get ticketing information for a ticket (7.21.07) ====
-==== Get all documents for a ticket (7.21.07) ====
 #first parameter: ticket id
-  WorkflowInterface.getDocuments(1500);
+  WorkflowInterface.getTicketInformation(1500);
-  ''returns'': array of objects with properties type, url, name, isticketdocument, isvisible, id, key and date in JSON
+  ''returns'': object with properties id, guid, processid, datestarted, dateended, workflowissubmitting, requestorperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), requestedforperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), islocked, isrunning, tickettype, tasktype, requestedforteam, pool (object with properties id and name), medium (object with properties code and name), priority (object with properties code and name), status (object with properties code and name), service (object with properties code and name), category (object with properties code and name), classification (object with properties code and name), closurecode (object with properties code and name), description, information, solution, solutionlinkalldocuments, solutiondocumentkeys (array of keys in string), plannedeliverydate, deadlinedate, requestedforalternatename, requestedforalternateemail, requestedforalternatetelephone, assignedtoperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtopersongroup (object with properties id, name and description), customfields (array of objects with properties name, typeid, typename, ishidden, parametername, parametervaluefield, parameterdisplayfield, stringvalue and datetimevalue) in JSON
-Use 'key' as unique identifier, this key is also used in other objects (eg in solutiondocumentkeys)
-==== Add document to a ticket ====
+==== Start a new process instance (7.21.12) ====
-#first parameter: TicketId
+#first parameter: process (id or name)
-#second parameter: Path to the file that should be added
+#second parameter: requestor person (id or unique id or email) (can be null since 7.24.03)
-#third parameter: boolean (1 or 0) if file should be visible in workflow
+#third parameter: requested for person (id or unique id or email) (can be null since 7.24.03)
-  WorkflowInterface.addDocument(ticketid, 'pathtofile', hideinworkflow);
+#fourth parameter: external app name
+#fifth parameter: array of form field objects, each object can have the properties displayvalue, value, internallabel, label and labels (array of objects with properties label and language)
+  WorkflowInterface.startProcessInstance("My test process", "John.Doe", "John.Doe", "my test app", [{ internallabel: "field1", value: "value 1", labels: [{ label: "field 1", language: "English" }, { label: "veld 1", language: "Nederlands" }] }, { value: "value 2", displayvalue: "dis val 2", label: "field 2" }]);
+ ''returns'': object with properties id and guid in JSON
-==== Add document to a ticket with a specific name ====
+==== Start a new process instance with passing thru initial ticketing data (7.21.12) ====
-#first parameter: TicketId
+#first parameter: process (id or name)
-#second parameter: Path to the file that should be added
+#second parameter: requestor person (id or unique id or email) (can be null since 7.24.03)
-#third parameter: filename to show in workflow
+#third parameter: requested for person (id or unique id or email) (can be null since 7.24.03)
-#fourth parameter: boolean (1 or 0) if file should be visible in workflow
+#fourth parameter: external app name
- WorkflowInterface.addDocumentWithFileName(ticketid, 'pathtofile', 'filenametoshow', hideinworkflow);
+#fifth parameter: array of form field objects, each object can have the properties displayvalue, value (or rawvalue 7.23.07), internallabel (or internalname 7.23.07), label and labels (array of objects with properties label and language)
+#sixth parameter: object with initial ticketing data, possible properties are assignedtoperson, assignedtopersongroup, category, classification, closurecode, deadlinedate, description, information, initialtasksfield, medium, planneddeliverydate, pool, priority, requestedfor, requestedforalternateemail, requestedforalternatename, requestedforalternatetelephone, requestedforteam, service, solution, status and customfields (array of objects with properties fieldname and stringvalue)
-==== Delete all currently linked documents from a ticket ====
+  WorkflowInterface.startProcessInstanceWithTicketData("My test process", "John.Doe", "John.Doe", "my test app", [{ internallabel: "field1", value: "value 1", labels: [{ label: "field 1", language: "English" }, { label: "veld 1", language: "Nederlands" }] }, { value: "value 2", displayvalue: "dis val 2", label: "field 2" }], { status: "New", assignedtopersongroup: "My first group", assignedtoperson: "John.Doe", "Description": "test", customfields: [{fieldname: "customfield1", stringvalue: "custom field value"}] });
-#first parameter: TicketId
+ ''returns'': object with properties id and guid in JSON
-  WorkflowInterface.deleteAllDocuments(ticketid);
-=== Update Ticketing fields ===
+=== Rights (7.21.07) ===
-==== Get action logs for a ticket (7.21.07) ====
+==== Check if the logged in person has workflow admin rights on the ticket ====
-Get a list of only action logs, that's pubic messages, private notes and ticket changes
 #first parameter: ticket id
-  WorkflowInterface.getActionLogs(1500);
+  WorkflowInterface.loggedInPersonHasWorkflowAdminRight(1500);
-  ''returns'': array of objects with properties date, person (object with properties id, firstname, lastname, email, uniqueid, description and inactive), text, typeid, typename, notified (array of names), documentkeys (array of keys in string) in JSON
+  ''returns'': true or false
-==== Add a public note within ticketing ====
-#first parameter: TicketId
-#second parameter: Person unique id or email address
-#third parameter: text to add as public note
- WorkflowInterface.addPrivateNote(ticketid, personidoremail, logtext);
-==== Add a private message within ticketing ====
+==== Check if the logged in person has workflow power user rights on the ticket ====
-#first parameter: TicketId
+#first parameter: ticket id
-#second parameter: Person unique id or email address
+  WorkflowInterface.loggedInPersonHasWorkflowPowerUserRight(1500);
-#third parameter: text to add as private note
+ ''returns'': true or false
-  WorkflowInterface.addPublicMessage(ticketid, personidoremail, logtext);
-==== Add a ticket change entry within ticketing====
+==== Check if the logged in person has workflow read rights on the ticket ====
-#first parameter: TicketId
+#first parameter: ticket id
-#second parameter: Person unique id or email address
+  WorkflowInterface.loggedInPersonHasWorkflowReadRight(1500);
-#third parameter: text to add as ticket change
+  ''returns'': true or false
-  WorkflowInterface.addTicketChange(ticketid, personidoremail, logtext);
-  ''This action will not send an email message''
-==== Update ticket fields ====
+==== Check if the logged in person has workflow write rights on the ticket ====
-#first parameter: TicketId
+#first parameter: ticket id
-#second parameter: object containing new field values
+  WorkflowInterface.loggedInPersonHasWorkflowWriteRight(1500);
- WorkflowInterface.updateTicketFields(ticketid, fields);
+  ''returns'': true or false
-  fields: object with a key field to set which field should be updated, together with the new value for example: WorkflowInterface.updateTicketFields(ticketid, {"Status": "Open", "Custom": {"Field01": "Value01" }});
-  Possible fields: LockTicket, TicketIsRunning, Classification, Status, Description, Information, AssignedToPerson, AssignedToPersonGroup, Category, Medium, Priority, Service, Solution, ClosureCode, Custom, Requestor, RequestedFor, Pool, PlannedDeliveryDate, DeadlineDate, RequestedForAlternateName, RequestedForAlternateEmail, RequestedForAlternateTelephone, SolutionLinkAllDocuments, RequestedForTeam, WorkflowPool, TicketType, TasksType, RemoveOnDate
-==== Lock ticket ====
+==== Check if the logged in person has ticketing limited rights on the ticket ====
-#first parameter: TicketId
+#first parameter: ticket id
-  WorkflowInterface.lockTicket(ticketid);
+  WorkflowInterface.loggedInPersonHasTicketLimitedRight(1500);
+ ''returns'': true or false
-==== Unlock ticket ====
+==== Check if the logged in person has ticketing read rights on the ticket ====
-#first parameter: TicketId
+#first parameter: ticket id
-  WorkflowInterface.unlockTicket(ticketid);
+  WorkflowInterface.loggedInPersonHasTicketReadRight(1500);
+ ''returns'': true or false
-==== Set ticket to IsRunning = True ====
+==== Check if the logged in person has ticketing write rights on the ticket ====
-#first parameter: TicketId
+#first parameter: ticket id
-  WorkflowInterface.enableTicketIsRunning(ticketid);
+  WorkflowInterface.loggedInPersonHasTicketWriteRight(1500);
+ ''returns'': true or false
-==== Set ticket to IsRunning = False ====
+==== Check if the logged in person has write rights on the task (no checks on ticket are done) ====
-  WorkflowInterface.disableTicketIsRunning(ticketid);
+#first parameter: task id
+  WorkflowInterface.loggedInPersonHasTaskWriteRight(100);
+ ''returns'': true or false
-====  Create a new, blank Task within a ticket ====
+=== Variables ===
-  WorkflowInterface.addTask(ticketid, fields);
+==== Get the value of a variable in a ticket ====
-  ''returns'': the new task id
+#first parameter: ticket id
+#second parameter: name of the variable
+  WorkflowInterface.getVariableValue(1500, 'My variable');
+  ''returns'': the value as string
+==== sets the value of a variable in a ticket (if it doesn't exists, it will be created) ====
+#first parameter: ticket id
+#second parameter: name of the variable
+#third parameter: value of the variable
+ WorkflowInterface.setVariableValue(1500, 'My variable', 'new value');
+ ''returns'': nothing
-==== Update fields of a task ====
+=== Form Values ===
-#first parameter: TicketId
+==== Get all form fields for a ticket (7.21.07) ====
-#second parameter: TaskId
+#first parameter: ticket id
-#third parameter: object containing new field values
+  WorkflowInterface.getAllFormFields(1500);
-  WorkflowInterface.updateTask(ticketid, taskid, fields);
+  ''returns'': array of objects with properties fieldorder, fieldtypeid, fieldtypename, internalname, label, helptext, subfielddefinition, parametername, value (object depending on the fieldtype), rawvalue, displayvalue, visible, htmlencode, repeatablesectionindex, repeatablesectionfieldid, visibleforui (since 7.23.10) in JSON
-  fields: object with a key field to set which field should be updated, together with the new value for example: WorkflowInterface.updateTask(ticketid, taskid, {"Status": "Open","Description":"My descriptionb" });
- Possible fields: Description, AssignedToPersonGroup, AssignedToPerson, DeliveryDate, Information, Solution, LockedTicket, IsCompleted, ExternalReference, ExternalResolved, LinkAllTicketDocuments, Status, Priority, DeadlineDate
-==== Get information for a task (7.21.07) ====
+==== Get raw value of a form field in a ticket ====
-#first parameter: task id
+#first parameter: ticket id
-  WorkflowInterface.getTask(100);
+#second parameter: internal name of the form field
-  ''returns'': object with properties id, processinstanceid, deliverydate, deadlinedate, dateadded, datecompleted, completed, requestor (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtoperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtopersongroup (object with properties id, name and description), description, information, priority (object with properties code and name), status (object with properties code and name), solution, duestatus, linkallticketdocuments, documentkeys (array of keys in string), hasexternallink, externallinkreference, lockedticket in JSON
+  WorkflowInterface.getFormFieldValue(1500, 'MyFormField');
+  ''returns'': the value as string
+==== Get raw displayvalue of a form field in a ticket ====
+#first parameter: ticket id
+#second parameter: internal name of the form field
+ WorkflowInterface.getFormFieldDisplayValue(1500, 'MyFormField');
+ ''returns'': the display value as string
-==== Get all tasks for a ticket (7.21.07) ====
+==== Get the value definition of a form field in a ticket (for selection fields) ====
 #first parameter: ticket id
-  WorkflowInterface.getTasks(1500);
+#second parameter: internal name of the form field
-  ''returns'': array of objects with properties id, processinstanceid, deliverydate, deadlinedate, dateadded, datecompleted, completed, requestor (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtoperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtopersongroup (object with properties id, name and description), description, information, priority (object with properties code and name), status (object with properties code and name), solution, duestatus, linkallticketdocuments, documentkeys (array of keys in string), hasexternallink, externallinkreference, lockedticket in JSON
+  WorkflowInterface.getFormFieldSubFieldDefinition(1500, 'MyFormField');
+  ''returns'': the definition (eg: Name||Email)
-=== Emails (since 7.21.06) ===
+==== Get the sub value of a form field in a ticket (for selection fields) ====
-==== Get an email layout ====
+#first parameter: ticket id
-#first parameter: name of the email layout
+#second parameter: internal name of the form field
-  WorkflowInterface.getEmailLayout(name);
+#third parameter: name of the sub field
-  ''returns'': the body of the email layout in the default language
+  WorkflowInterface.getFormSubFieldValue(1500, 'MyFormField', 'Name');
- When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.
+  ''returns'': the value as string (eg: Raymond)
-==== Get an email layout in a specific language ====
+==== Get the list of sub value of a form field in a ticket (for selection fields with multiple values) ====
-#first parameter: name of the email layout
+#first parameter: ticket id
-#second parameter: id of the desired language
+#second parameter: internal name of the form field
-  WorkflowInterface.getEmailLayoutWithLanguageId(name, languageid);
+#third parameter: name of the sub field
-  ''returns'': the body of the email layout in the desired language
+  WorkflowInterface.getFormSubFieldValues(1500, 'MyFormField', 'Name');
- When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.
+  ''returns'': the values as string array in JSON (eg: ["Dominic", "Raymond"])
-==== Get the default email layout ====
+==== Get an object (key/value) where key is the sub field name and value the selected values of a form field in a ticket (for selection fields with single value) ====
-  WorkflowInterface.getDefaultEmailLayout();
+#first parameter: ticket id
-  ''returns'': the body of the default email layout in the default language
+#second parameter: internal name of the form field
- When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.
+  WorkflowInterface.getFormFieldSelectionValue(1500, 'MyFormField');
+  ''returns'': object in JSON (eg: {"Name": "Raymond", "Email": "raymond@smt-x.com"})
-==== Get the default email layout in a specific language ====
+==== Get a list of objects (key/value) where key is the sub field name and value the selected values of a form field in a ticket (for selection fields with multiple values) ====
-#first parameter: id of the desired language
+#first parameter: ticket id
-  WorkflowInterface.getDefaultEmailLayoutWithLanguageId(languageid);
+#second parameter: internal name of the form field
-  ''returns'': the body of the default email layout in the desired language
+  WorkflowInterface.getFormFieldSelectionValues(1500, 'MyFormField');
-  When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.
+  ''returns'': array of objects in JSON (eg: [{"Name": "Raymond", "Email": "raymond@smt-x.com"},{"Name": "Dominic", "Email": "dominic@smt-x.com"}])
+=== Open actions ===
+==== Get the open (step) actions in a ticket ====
+#first parameter: ticket id
+ WorkflowInterface.getOpenActions(1500);
+  ''returns'': array of open actions in JSON (properties: stepname, stepinformation, link, array of actors (person), messagesfunctionid, allowsubmit, typeid, pisiaid, pisianame, submithash, array of fields (properties: id, name, typeid, required, stringvalue, displaystringvalue, datetimevalue, pdbname, pdbvaluefieldname, pdbtextfieldname, pdbhashcheck, rows, regex, helptext), haswriterights (since 7.23.10))
+==== Get the amount of open actions for the logged in user (7.24.07) ====
+ WorkflowInterface.getMyOpenActionsCountSecure();
+ ''returns'': the amount of open actions for the logged in user
+==== Get the amount of open actions for a specific email address (7.24.07) ====
+#first parameter: email
+ WorkflowInterface.getOpenActionsByEmailCount(email);
+ ''returns'': the amount of open actions for the email address
-==== Get an email template (7.22.09) ====
+==== Get the open actions for the logged in user (7.24.07) ====
-#first parameter: name of the email template
+  WorkflowInterface.getMyOpenActionsSecure();
-#optional second parameter: language id you wish to use
+  ''returns'': an array of objects with properties processinstanceid, processinstanceguid, processinstancestepid, processinstancestepactorid, processinstancestepinstanceactorinstanceid, datestarted, stepname, link, processinstancename, processinstancedatestarted, processinstancerequestorperson, processinstancerequestedforperson in JSON
-  WorkflowInterface.getEmailTemplate(name);
-  ''returns'': an object with properties subject, body and attachments (array of objects with properties url and name) in JSON
-==== Send an email ====
+==== Get the open actions for a specific email address (7.24.07) ====
-#first parameter: full name of the receiver
+#first parameter: email
-#second parameter: email address of the receiver
+  WorkflowInterface.getOpenActionsByEmail(email);
-#third parameter: subject of the email
+  ''returns'': an array of objects with properties processinstanceid, processinstanceguid, processinstancestepid, processinstancestepactorid, processinstancestepinstanceactorinstanceid, datestarted, stepname, link, processinstancename, processinstancedatestarted, processinstancerequestorperson, processinstancerequestedforperson in JSON
-#fourth parameter: content of the email
-  WorkflowInterface.sendEmail(toName, toEmail, subject, content);
-  sends the email immediately when "Send immediately" is enabled in the settings, will add the email to the queue otherwise
-==== Queue an email ====
+=== Steps (since 7.24.10) ===
-#first parameter: full name of the receiver
+==== Get all steps as tree in a ticket ====
-#second parameter: email address of the receiver
+Get all steps as tree in a ticket
-#third parameter: subject of the email
+#first parameter: ticket id
-#fourth parameter: content of the email
+  WorkflowInterface.getSteps(1500);
-  WorkflowInterface.queueEmail(toName, toEmail, subject, content);
+  ''returns'': array of objects in JSON
-  adds the email to the queue
-==== Send an email - advanced ====
+==== Get all steps as tree in a ticket secure ====
-#first parameter: object with properties
+Get all steps as tree in a ticket visible for the logged in person
-  WorkflowInterface.sendEmailAdvanced(properties);
+#first parameter: ticket id
- Possible properties: from, fromemail, fromname, to, toemail, toname, cc, ccemail, ccname, bcc, bccemail, bccname, attachments, subject, content, ishtml, disableoverwriteto, processinstanceid
+  WorkflowInterface.getStepsSecure(1500);
- ''from'': can be a string (email address) or an object with the properties 'email' and 'name'
+  ''returns'': array of objects in JSON
-  ''to, cc and bcc'': can be a string (email address), an object with the properties 'email' and 'name' or an array with strings and or objects with the properties 'email' and 'name'
- ''attachments'': can be a string (location of the file), an object with the properties 'url' and 'name' or an array with strings and or objects with the properties 'url' and 'name'
- ''disableoverwriteto'': boolean to specify whether the "Send all e-mails only to" should be ignored or not
- ''processinstanceid'': id of the workflow ticket to link this email to
- Required properties: subject, content and at least one 'to' addressee are required
- Example: WorkflowInterface.sendEmailAdvanced({"to": "raymond@smt-x.com", "cc": [{email: "dominic@smt-x.com", name: "Dominic"}], "subject": "The subject of my email", "content": "The &lt;strong&gt;content&lt;/strong&gt; of my email" });
- sends the email immediately when "Send immediately" is enabled in the settings, will add the email to the queue otherwise
-==== Queue an email - advanced ====
+==== Get all steps as list in a ticket (since 7.25.02) ====
-#first parameter: object with properties
+Get all steps as list in a ticket
-  WorkflowInterface.queueEmailAdvanced(properties);
+#first parameter: ticket id
- Possible properties: from, fromemail, fromname, to, toemail, toname, cc, ccemail, ccname, bcc, bccemail, bccname, attachments, subject, content, ishtml, disableoverwriteto, processinstanceid
+  WorkflowInterface.getStepsAsList(1500);
- ''from'': can be a string (email address) or an object with the properties 'email' and 'name'
+  ''returns'': array of objects in JSON
-  ''to, cc and bcc'': can be a string (email address), an object with the properties 'email' and 'name' or an array with strings and or objects with the properties 'email' and 'name'
- ''attachments'': can be a string (location of the file), an object with the properties 'url' and 'name' or an array with strings and or objects with the properties 'url' and 'name'
- ''disableoverwriteto'': boolean to specify whether the "Send all e-mails only to" should be ignored or not
- ''processinstanceid'': id of the workflow ticket to link this email to
- Required properties: subject, content and at least one 'to' addressee are required
- Example: WorkflowInterface.queueEmailAdvanced({"to": "raymond@smt-x.com", "cc": [{email: "dominic@smt-x.com", name: "Dominic"}], "subject": "The subject of my email", "content": "The &lt;strong&gt;content&lt;/strong&gt; of my email" });
- adds the email to the queue
-== StudioInterface ==
+==== Get all steps as list in a ticket secure (since 7.25.02) ====
+Get all steps as list in a ticket visible for the logged in person
+#first parameter: ticket id
+ WorkflowInterface.getStepsAsListSecure(1500);
+ ''returns'': array of objects in JSON
-=== Get the full query string ===
+=== Additional information (since 7.24.11) ===
-  StudioInterface.getQueryString();
+==== Submit the answer for an additional information request ====
-  ''return'': the full query string (without the leading question mark)
+Submits the answer without checking the logged in user
+#first parameter: id
+#second parameter: answer
+  WorkflowInterface.submitAdditionalInformationAnswer(150, 'answer');
+  ''returns'': true if succesful, false if it was already answered, null if not found or no rights
-=== Get all keys from the query string parameter collection (7.22.03) ===
+==== Submit the answer for an additional information request secure ====
-  StudioInterface.getAllQueryStringKeys();
+Submits the answer only if the logged in user is allowed to
-  ''return'': an array of strings with all the keys of the query string parameters for the current request
+#first parameter: id
+#second parameter: answer
+  WorkflowInterface.submitAdditionalInformationAnswerSecure(150, 'answer');
+  ''returns'': true if succesful, false if it was already answered, null if not found or no rights
-=== Get a value from the query string ===
+=== Logging ===
-  StudioInterface.getQueryStringValue('name');
+==== Get all logs for a ticket (7.21.07) ====
-  ''return'': the value of the query string parameter for the current request
+Get a list with all logs, including workflow logs, private notes, public messages and ticket changes
+#first parameter: ticket id
+  WorkflowInterface.getAllLogs(1500);
+  ''returns'': array of objects with properties date, person (object with properties id, firstname, lastname, email, uniqueid, description and inactive), text, typeid, typename, notified (array of names), documentkeys (array of keys in string) in JSON
-=== Get all keys from the header collection (7.22.03) ===
+==== Get workflow logs for a ticket (7.21.07) ====
-  StudioInterface.getAllHeaderKeys();
+Get a list of only workflow logs
-  ''return'': an array of strings with all the keys of the headers for the current request
+#first parameter: ticket id
+  WorkflowInterface.getWorkflowLogs(1500);
+  ''returns'': array of objects with properties date, person (object with properties id, firstname, lastname, email, uniqueid, description and inactive), text, typeid, typename, notified (array of names), documentkeys (array of keys in string) in JSON
-=== Get a value from the header ===
+==== Add a log to the process instance (workflow log) ====
-#first parameter: name
+#first parameter: ticket id
-  StudioInterface.getHeaderValue('name');
+#second parameter: the log text
-  ''return'': the value of the header parameter for the current request
+  WorkflowInterface.addWorkflowLog(1500, 'My log text');
+  ''returns'': nothing
-=== Get all keys from the cookie collection (7.22.03) ===
+=== Attachments ===
-  StudioInterface.getAllCookieKeys();
+==== Get all documents for a ticket (7.21.07) ====
-  ''return'': an array of strings with all the keys of the cookies for the current request
+#first parameter: ticket id
+  WorkflowInterface.getDocuments(1500);
+  ''returns'': array of objects with properties type, url, name, isticketdocument, isvisible, id, key and date in JSON
+Use 'key' as unique identifier, this key is also used in other objects (eg in solutiondocumentkeys)
-=== Get a value from the cookie ===
+==== Add document to a ticket ====
-#first parameter: name
+#first parameter: TicketId
-  StudioInterface.getCookieValue('name');
+#second parameter: Path to the file that should be added
-  ''return'': the value of the cookie for the current request
+#third parameter: boolean (1 or 0) if file should be visible in workflow
+  WorkflowInterface.addDocument(ticketid, 'pathtofile', hideinworkflow);
+  ''returns'': since 7.24.11: the document key
-=== Set a cookie (7.22.03) ===
+==== Add document to a ticket with a specific name ====
-Adds a cookie, if no expire days is provided, then it's a session cookie (will be removed when session ends)
+#first parameter: TicketId
-#first parameter: name
+#second parameter: Path to the file that should be added
-#second parameter: value
+#third parameter: filename to show in workflow
-#third parameter (optional): expire in nr of days (a negative value will remove the cookie)
+#fourth parameter: boolean (1 or 0) if file should be visible in workflow
-  StudioInterface.setCookie('cookiename', 'cookievalue');
+  WorkflowInterface.addDocumentWithFileName(ticketid, 'pathtofile', 'filenametoshow', hideinworkflow);
-  ''return'': nothing
+  ''returns'': since 7.24.11: the document key
-=== Get all keys from the posted form collection (7.22.03) ===
+==== Add document as base64 to a ticket (7.25.01) ====
-  StudioInterface.getAllFormKeys();
+#first parameter: ticketid
-  ''return'': an array of strings with all the keys of the posted form collection for the current request
+#second parameter: file in base64
+#third parameter: filename
+#fourth parameter: boolean (1 or 0) if file should be visible in workflow
+  WorkflowInterface.addDocumentInBase64(ticketid, 'dGVzdA==', 'test.txt', hideinworkflow);
+  ''returns'': the document key
-=== Get a value from the posted form collection ===
+==== Delete all currently linked documents from a ticket ====
-#first parameter: name
+#first parameter: TicketId
-  StudioInterface.getFormValue('name');
+  WorkflowInterface.deleteAllDocuments(ticketid);
- ''return'': the value from the posted form collection for the current request
-=== Get the http method for the current request ===
+=== Update Ticketing fields ===
-  StudioInterface.getHttpMethod();
+==== Get action logs for a ticket (7.21.07) ====
-  ''return'': the current http method (GET, POST, …)
+Get a list of only action logs, that's pubic messages, private notes and ticket changes
+#first parameter: ticket id
+  WorkflowInterface.getActionLogs(1500);
+  ''returns'': array of objects with properties date, person (object with properties id, firstname, lastname, email, uniqueid, description and inactive), text, typeid, typename, notified (array of names), documentkeys (array of keys in string) in JSON
-=== Get the content type of the current request ===
+==== Get action logs secure for a ticket (7.24.10) ====
-  StudioInterface.getContentType();
+Get a list of only action logs, that's pubic messages, private notes and ticket changes only if the logged in user is allowed to see them
-  ''return'': the content type (text/plain, application/json, …)
+#first parameter: ticket id
+  WorkflowInterface.getActionLogsSecure(1500);
+  ''returns'': array of objects with properties date, person (object with properties id, firstname, lastname, email, uniqueid, description and inactive), text, typeid, typename, notified (array of names), documentkeys (array of keys in string) in JSON
-=== Get the full posted content as string ===
+==== Add a public note within ticketing ====
-  StudioInterface.getPostedContent();
+#first parameter: TicketId
- ''return'': posted content
+#second parameter: Person unique id or email address
+#third parameter: text to add as public note
+#optional fourth parameter: array of objects with properties filename and filecontentinbase64 (7.24.10)
+  WorkflowInterface.addPrivateNote(ticketid, personidoremail, logtext);
-=== Get the current language culture ===
+==== Add a private message within ticketing ====
- StudioInterface.getCurrentLanguageCulture();
+#first parameter: TicketId
-  ''return'': the culture (nl-BE, en-GB, …)
+#second parameter: Person unique id or email address
+#third parameter: text to add as private note
+#optional fourth parameter: array of objects with properties filename and filecontentinbase64 (7.24.10)
+  WorkflowInterface.addPublicMessage(ticketid, personidoremail, logtext);
-=== Get the current language name ===
+==== Add a ticket change entry within ticketing====
-  StudioInterface.getCurrentLanguageName();
+#first parameter: TicketId
-  ''return'': the name (English, Nederlands, …)
+#second parameter: Person unique id or email address
+#third parameter: text to add as ticket change
+#optional fourth parameter: array of objects with properties filename and filecontentinbase64 (7.24.10)
+  WorkflowInterface.addTicketChange(ticketid, personidoremail, logtext);
+  ''This action will not send an email message''
-=== Get the current language id ===
+==== Update ticket fields ====
-  StudioInterface.getCurrentLanguageId();
+#first parameter: TicketId
-  ''return'': the id (1, 2, …)
+#second parameter: object containing new field values
+  WorkflowInterface.updateTicketFields(ticketid, fields);
+  fields: object with a key field to set which field should be updated, together with the new value for example: WorkflowInterface.updateTicketFields(ticketid, {"Status": "Open", "Custom": {"Field01": "Value01" }});
+ Possible fields: LockTicket, TicketIsRunning, Classification, Status, Description, Information, AssignedToPerson, AssignedToPersonGroup, Category, Medium, Priority, Service, Solution, ClosureCode, Custom, Requestor, RequestedFor, Pool, PlannedDeliveryDate, DeadlineDate, RequestedForAlternateName, RequestedForAlternateEmail, RequestedForAlternateTelephone, SolutionLinkAllDocuments, RequestedForTeam, WorkflowPool, TicketType, TasksType, RemoveOnDate. Since 7.23.05: CustomFields (array of objects with properties fieldname and stringvalue)
-=== Check if there is a logged in person (7.21.07) ===
+==== Lock ticket ====
-  StudioInterface.hasLoggedInPerson();
+#first parameter: TicketId
- ''return'': true or false
+  WorkflowInterface.lockTicket(ticketid);
-=== Get the logged in person (7.21.07) ===
+==== Unlock ticket ====
-  StudioInterface.getLoggedInPerson();
+#first parameter: TicketId
- ''return'': object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
+  WorkflowInterface.unlockTicket(ticketid);
-=== Get the field value for the current logged in person ===
+==== Set ticket to IsRunning = True ====
-#first parameter: fieldname
+#first parameter: TicketId
-  StudioInterface.getLoggedInPersonField('FirstName');
+  WorkflowInterface.enableTicketIsRunning(ticketid);
- ''return'': the value (Raymond, Dominic, …)
- Possible fields: UniqueId, FirstName, LastName, Email, all person extra fields defined in adapters.
-=== Get the first and last name for the current logged in person ===
+==== Set ticket to IsRunning = False ====
-  StudioInterface.getLoggedInPersonFirstAndLastName();
+  WorkflowInterface.disableTicketIsRunning(ticketid);
- ''return'': the first and last name (Raymond Crijnen, Dominic De Vilder, …)
-=== Get the description as defined in the settings for the current logged in person ===
+====  Create a new, blank Task within a ticket ====
-  StudioInterface.getLoggedInPersonDescription();
+#first parameter: TicketId
-  ''return'': the description (Raymond Crijnen (raymond@smt-x.com - CrijnenR))
+#second parameter: object containing new field values
+#third optional parameter (since 7.23.10): the id of the person used as requestor person
+  WorkflowInterface.addTask(ticketid, fields);
+  ''returns'': the new task id
-=== Get the dateformat as defined for the current logged in person (7.22.06) ===
+==== Update fields of a task ====
-  StudioInterface.getLoggedInPersonDateFormat();
+#first parameter: TicketId
-  ''return'': the dateformat (dd/MM/yyyy)
+#second parameter: TaskId
+#third parameter: object containing new field values
+  WorkflowInterface.updateTask(ticketid, taskid, fields);
+  fields: object with a key field to set which field should be updated, together with the new value for example: WorkflowInterface.updateTask(ticketid, taskid, {"Status": "Open","Description":"My descriptionb" });
+ Possible fields: Description, AssignedToPersonGroup, AssignedToPerson, DeliveryDate, Information, Solution, LockedTicket, IsCompleted, ExternalReference, ExternalResolved, LinkAllTicketDocuments, Status, Priority, DeadlineDate, since 7.23.09: Category, ConfigurationItem, since 7.24.12: Subcategory
-=== Checks if the logged in person has the specified role ===
+==== Add a message to a task (7.24.10) ====
-#first parameter: Role name
+#first parameter: TicketId
-  StudioInterface.loggedInPersonHasRole('Name of the role');
+#second parameter: TaskId
- ''return'': true if the user has the role, false otherwise
+#third parameter: person
+#fourth parameter: text
+  WorkflowInterface.addTaskMessage(1500, 150, "john@doe.com", "text");
-=== Checks if the logged in person has any of the specified roles (7.21.08) ===
+==== External system acknowledged a task (7.25.01) ====
-#first parameter: array of role names
+#first parameter: TicketId
-  StudioInterface.loggedInPersonHasAnyRole(['Name of the role1', 'Name of the role2']);
+#second parameter: TaskId
- ''return'': true if the user has any of the roles, false otherwise
+#third parameter: person
+#fourth parameter: externalLinkReference
+#fifth parameter: extraMessage
+  WorkflowInterface.taskAcknowledgementFromExternal(1500, 150, "john@doe.com", "EXT-12345", "Ticket received");
-=== Checks if the logged in person has all of the specified roles (7.21.08) ===
+==== External system adds an update message to a task (7.25.01) ====
-#first parameter: array of role names
+#first parameter: TicketId
-  StudioInterface.loggedInPersonHasAllRoles(['Name of the role1', 'Name of the role2']);
+#second parameter: TaskId
- ''return'': true if the user has all of the roles, false otherwise
+#third parameter: person
+#fourth parameter: updateMessage
+  WorkflowInterface.taskUpdateMessageFromExternal(1500, 150, "john@doe.com", "Update information");
-=== Checks if the logged in person is an admin (7.22.06) ===
+==== External system reassigns a task (7.25.01) ====
-  StudioInterface.loggedInPersonIsAdmin();
+#first parameter: TicketId
- ''return'': true if the user is admin, false otherwise
+#second parameter: TaskId
+#third parameter: person
+#fourth parameter: updateMessage
+  WorkflowInterface.taskReassignmentFromExternal(1500, 150, "john@doe.com", "The solution");
-=== Get a translation ===
+==== Send update message to an external task (7.25.01) ====
-#first parameter: Category
+#first parameter: TicketId
-#second parameter: Label
+#second parameter: TaskId
-  StudioInterface.translate('Common', 'Profile');
+#third parameter: person
- ''return'': the translation value for the SSP translations
+#fourth parameter: updateMessage
+  WorkflowInterface.taskUpdateMessageToExternal(1500, 150, "john@doe.com", "Update information");
-=== Get the root of the ssp location ===
+==== Send update message to an external task, only if the logged in user has the rights for this (7.25.01) ====
-  StudioInterface.getSspRoot();
+#first parameter: TicketId
- ''return'': the http location, including the trailing slash (https:=== ssp/)
+#second parameter: TaskId
+#third parameter: updateMessage
+  WorkflowInterface.taskUpdateMessageToExternalSecure(1500, 150, "Update information");
-=== Get the http path to the current application ===
+==== Reject the solution for an external task (7.25.01) ====
-  StudioInterface.getApplicationPath();
+#first parameter: TicketId
- ''return'': the http location, without the trailing slash (https:=== ssp/myapp)
+#second parameter: TaskId
+#third parameter: person
+#fourth parameter: rejectMessage
+  WorkflowInterface.taskRejectSolutionToExternal(1500, 150, "john@doe.com", "Reject info");
-=== Get the application folder name (7.22.09) ===
+==== Reject the solution for an external task, only if the logged in user has the rights for this (7.25.01) ====
-  StudioInterface.getApplicationFolder();
+#first parameter: TicketId
- ''return'': the name of the folder (eg myapp)
+#second parameter: TaskId
+#third parameter: rejectMessage
+  WorkflowInterface.taskRejectSolutionToExternalSecure(1500, 150, "Reject info");
-=== Get the current folder name (full) inside the current application ===
+==== Get information for a task (7.21.07) ====
-  StudioInterface.getCurrentFolderName();
+#first parameter: task id
-  ''return'': the current full folder path, including the starting and trailing slash (/subfolder/content/)
+  WorkflowInterface.getTask(100);
+  ''returns'': object with properties id, processinstanceid, deliverydate, deadlinedate, dateadded, datecompleted, completed, requestor (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtoperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtopersongroup (object with properties id, name and description), description, information, priority (object with properties code and name), status (object with properties code and name), solution, duestatus, linkallticketdocuments, documentkeys (array of keys in string), hasexternallink, externallinkreference, lockedticket, since 7.23.09 category (object with properties code and name), configurationitem (object with properties code and name), since 7.24.12 subcategory (object with properties code and name), since 7.25.01 updatemessageavailable, rejectsolutionavailable in JSON
-=== Get the current file name inside the current application ===
+==== Get all tasks for a ticket (7.21.07) ====
-  StudioInterface.getCurrentName();
+#first parameter: ticket id
-  ''return'': the current file name (index.html)
+  WorkflowInterface.getTasks(1500);
+  ''returns'': array of objects with properties id, processinstanceid, deliverydate, deadlinedate, dateadded, datecompleted, completed, requestor (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtoperson (object with properties id, firstname, lastname, email, uniqueid, description and inactive), assignedtopersongroup (object with properties id, name and description), description, information, priority (object with properties code and name), status (object with properties code and name), solution, duestatus, linkallticketdocuments, documentkeys (array of keys in string), hasexternallink, externallinkreference, lockedticket, since 7.23.09 category (object with properties code and name), configurationitem (object with properties code and name), since 7.24.10: messages (array of objects with properties date, person, text), since 7.24.12 subcategory (object with properties code and name), since 7.25.01 updatemessageavailable, rejectsolutionavailable in JSON
-=== Get the current full path of the file inside the current application ===
+=== Emails (since 7.21.06) ===
-  StudioInterface.getCurrentPath();
+==== Get an email layout ====
-  ''return'': the current file name (/subfolder/content/index.html)
+#first parameter: name of the email layout
+  WorkflowInterface.getEmailLayout(name);
+  ''returns'': the body of the email layout in the default language
+ When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.
-=== Get the current application id (7.22.06) ===
+==== Get an email layout in a specific language ====
-  StudioInterface.getCurrentApplicationId();
+#first parameter: name of the email layout
-  ''return'': the id of the application
+#second parameter: id of the desired language
+  WorkflowInterface.getEmailLayoutWithLanguageId(name, languageid);
+  ''returns'': the body of the email layout in the desired language
+ When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.
-=== renders the application file as a string ===
+==== Get the default email layout ====
-#first parameter: string to be rendered
+  WorkflowInterface.getDefaultEmailLayout();
-  StudioInterface.renderAsString('/subfolder/content/index.html');
+  ''returns'': the body of the default email layout in the default language
-  ''return'': the rendered content
+ When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.
-=== renders the application file as a string, passing thru the parameters to the rendering script ===
+==== Get the default email layout in a specific language ====
-#first parameter: Application file
+#first parameter: id of the desired language
-#second parameter: object with parameters
+  WorkflowInterface.getDefaultEmailLayoutWithLanguageId(languageid);
-  StudioInterface.renderAsStringWithParameters('/subfolder/content/index.html', { 'Title': 'My title', 'Summary': 'My summary' });
+  ''returns'': the body of the default email layout in the desired language
-  ''return'': the rendered content (the parameters are accessible in the processing script of the file to render, use g_parameters)
+ When using a template in JavaScript, please be aware that the string #REPLACE-EmailContent# is replaced within your JavaScript code, before it is executed. If you want to use Layouts in JavaScript, create a specific Layout for that and don't make use of the placeholder #REPLACE-EmailContent#. Instead use for example JS-REPLACE-EMAILCONTENT.
-=== renders the application file and returns the rendered object ===
+==== Get an email template (7.22.09) ====
-#first parameter: Application file
+#first parameter: name of the email template
-  StudioInterface.render('/subfolder/content/index.html');
+#optional second parameter: language id you wish to use
-  ''return'': the rendered object with these properties: action, content, contenttype, templatezones, templateparameters
+  WorkflowInterface.getEmailTemplate(name);
+  ''returns'': an object with properties subject, body and attachments (array of objects with properties url and name) in JSON
-=== renders the application file, passing thru the parameters to the rendering script ===
+==== Send an email ====
-  StudioInterface.renderWithParameters('/subfolder/content/index.html', { 'Title': 'My title', 'Summary': 'My summary' });
+#first parameter: full name of the receiver
-  ''return'': the rendered object (see .render for details)
+#second parameter: email address of the receiver
+#third parameter: subject of the email
+#fourth parameter: content of the email
+  WorkflowInterface.sendEmail(toName, toEmail, subject, content);
+  sends the email immediately when "Send immediately" is enabled in the settings, will add the email to the queue otherwise
-=== Get the value for the application variable ===
+==== Queue an email ====
-#first parameter: Variable name
+#first parameter: full name of the receiver
-  StudioInterface.getVariableValue('my variable');
+#second parameter: email address of the receiver
-  ''return'': the value (type is depending on the variable)
+#third parameter: subject of the email
+#fourth parameter: content of the email
+  WorkflowInterface.queueEmail(toName, toEmail, subject, content);
+  adds the email to the queue
-=== Get the value for the application variable, passing thru the parameters to the variable script ===
+==== Send an email - advanced ====
-#first parameter: Variable name
+#first parameter: object with properties
-#second parameter: object with parameters (passed through to the variable script)
+ WorkflowInterface.sendEmailAdvanced(properties);
-  StudioInterface.getVariableValueWithParameters('my custom variable function', { 'Number': 8 });
+ Possible properties: from, fromemail, fromname, to, toemail, toname, cc, ccemail, ccname, bcc, bccemail, bccname, attachments, subject, content, ishtml, disableoverwriteto, processinstanceid
-  ''return'': the value (type is depending on the variable)
+ ''from'': can be a string (email address) or an object with the properties 'email' and 'name'
+ ''to, cc and bcc'': can be a string (email address), an object with the properties 'email' and 'name' or an array with strings and or objects with the properties 'email' and 'name'
+ ''attachments'': can be a string (location of the file), an object with the properties 'url' and 'name' or an array with strings and or objects with the properties 'url' and 'name'
+  ''disableoverwriteto'': boolean to specify whether the "Send all e-mails only to" should be ignored or not
+  ''processinstanceid'': id of the workflow ticket to link this email to
+ Required properties: subject, content and at least one 'to' addressee are required
+ Example: WorkflowInterface.sendEmailAdvanced({"to": "raymond@smt-x.com", "cc": [{email: "dominic@smt-x.com", name: "Dominic"}], "subject": "The subject of my email", "content": "The &lt;strong&gt;content&lt;/strong&gt; of my email" });
+ sends the email immediately when "Send immediately" is enabled in the settings, will add the email to the queue otherwise
+ Since 7.23.05: returns the id of the record
-=== Views (7.22.06) ===
+==== Queue an email - advanced ====
-==== getViewCountByName ====
+#first parameter: object with properties
-Get the count of a view by it's name
+ WorkflowInterface.queueEmailAdvanced(properties);
-#first parameter is the name of the view
+ Possible properties: from, fromemail, fromname, to, toemail, toname, cc, ccemail, ccname, bcc, bccemail, bccname, attachments, subject, content, ishtml, disableoverwriteto, processinstanceid
-#optional second parameter can be an object with properties "GetFromSource" or "AllowDbAccess"
+ ''from'': can be a string (email address) or an object with the properties 'email' and 'name'
-  CommonInterface.getViewCountByName("view1");
+ ''to, cc and bcc'': can be a string (email address), an object with the properties 'email' and 'name' or an array with strings and or objects with the properties 'email' and 'name'
-  ''returns'': the count of the view
+ ''attachments'': can be a string (location of the file), an object with the properties 'url' and 'name' or an array with strings and or objects with the properties 'url' and 'name'
+ ''disableoverwriteto'': boolean to specify whether the "Send all e-mails only to" should be ignored or not
+ ''processinstanceid'': id of the workflow ticket to link this email to
+ Required properties: subject, content and at least one 'to' addressee are required
+  Example: WorkflowInterface.queueEmailAdvanced({"to": "raymond@smt-x.com", "cc": [{email: "dominic@smt-x.com", name: "Dominic"}], "subject": "The subject of my email", "content": "The &lt;strong&gt;content&lt;/strong&gt; of my email" });
+  adds the email to the queue
+ Since 7.23.05: returns the id of the record
+== StudioInterface ==
-==== getViewCountById ====
+=== Get the full query string ===
-Get the count of a view by it's id
+  StudioInterface.getQueryString();
-#first parameter is the id of the view
+  ''return'': the full query string (without the leading question mark)
-#optional second parameter can be an object with properties "GetFromSource" or "AllowDbAccess"
-  CommonInterface.getViewCountById(1);
-  ''returns'': the count of the view
-==== getViewDataByName ====
+=== Get all keys from the query string parameter collection (7.22.03) ===
-Get the data of a view by it's name
+  StudioInterface.getAllQueryStringKeys();
-#first parameter is the name of the view
+  ''return'': an array of strings with all the keys of the query string parameters for the current request
- CommonInterface.getViewDataByName("view1");
- ''returns'': the data of the view in JSON
-==== searchViewDataByName (7.22.08) ====
-Search the data of a view by it's name
-#first parameter is the name of the view
-#second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum
-#optional third parameter is an object with properties PageIndex, PageSize, OrderBy
-  CommonInterface.searchViewDataByName("view1", [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
-  ''returns'': the data of the search results in JSON
-==== getViewDataByNames ====
+=== Get a value from the query string ===
-Get the data of multiple views by their names
+  StudioInterface.getQueryStringValue('name');
-#first parameter is an array of the name of the views
+  ''return'': the value of the query string parameter for the current request
-  CommonInterface.getViewDataByNames(["view1", "view2"]);
-  ''returns'': the data of the views in JSON
-==== searchViewDataByNames (7.22.08) ====
-Search the data of a view by their names
-#first parameter is an array of the name of the views
-#second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum
-#optional third parameter is an object with properties PageIndex, PageSize, OrderBy
- CommonInterface.searchViewDataByName(["view1", "view2"], [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
- ''returns'': the data of the search results in JSON
-==== getViewDataForTicketsByName ====
+=== Get values in an array from the query string (7.24.03) ===
-Search for tickets and get the results back as defined in the view by the views name
+  StudioInterface.getQueryStringValues('name');
-#first parameter is the name of the view
+  ''return'': the values of the query string parameter for the current request in an array
-#second parameter is an object with the search predicates (possible properties are "CustomKey", "Id", "Status", "Keywords", "RequestorId", "DateStartedFrom", "DateStartedTo", "DateEndedFrom", "DateEndedTo")
-#optional third parameter is an object with the paging settings
-  CommonInterface.getViewDataForTicketsByName("view1", { "Status": "Open" });
-  ''returns'': the tickets formatted as defined in the view in JSON
-==== getViewDataById ====
+=== Get all keys from the header collection (7.22.03) ===
-Get the data of a view by it's id
+ StudioInterface.getAllHeaderKeys();
-#first parameter is the id of the view
+ ''return'': an array of strings with all the keys of the headers for the current request
-  CommonInterface.getViewDataById(1);
-  ''returns'': the data of the view in JSON
+=== Get a value from the header ===
+#first parameter: name
-==== searchViewDataById (7.22.08) ====
+  StudioInterface.getHeaderValue('name');
-Get the data of a view by it's id
+  ''return'': the value of the header parameter for the current request
-#first parameter is the id of the view
-#second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum
+=== Get values in an array from the header (7.24.03) ===
-#optional third parameter is an object with properties PageIndex, PageSize, OrderBy
+#first parameter: name
-  CommonInterface.searchViewDataById(1, [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
+  StudioInterface.getHeaderValues('name');
-  ''returns'': the data of the search results in JSON
+  ''return'': the values of the header parameter for the current request in an array
-==== getViewDataByIds ====
+=== Get all keys from the server variables collection (7.24.02) ===
-Get the data of multiple views by their ids
+  StudioInterface.getAllServerVariableKeys();
-#first parameter is an array of ids of the views
+  ''return'': an array of strings with all the keys of the server variables collection for the current request
- CommonInterface.getViewDataByIds([1, 2]);
- ''returns'': the data of the views in JSON
-==== searchViewDataByIds (7.22.08) ====
-Get the data of multiple views by their ids
-#first parameter is an array of ids of the views
-#second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum
-#optional third parameter is an object with properties PageIndex, PageSize, OrderBy
-  CommonInterface.searchViewDataByName([1, 2], [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
-  ''returns'': the data of the search results in JSON
-==== getViewDataForTicketsById ====
+=== Get a value from the server variables (7.24.02) ===
-Search for tickets and get the results back as defined in the view by the views id
+#first parameter: name
-#first parameter is the id of the view
+  StudioInterface.getServerVariableValue('REMOTE_ADDR');
-#second parameter is an object with the search predicates (possible properties are "CustomKey", "Id", "Status", "Keywords", "RequestorId", "DateStartedFrom", "DateStartedTo", "DateEndedFrom", "DateEndedTo")
+  ''return'': the value of the server variable for the current request
-#optional third parameter is an object with the paging settings
-  CommonInterface.getViewDataForTicketsById(1, { "Status": "Open" });
-  ''returns'': the tickets formatted as defined in the view in JSON
-== Service Catalog Interface ==
+=== Get values in an array from the server variables (7.24.03) ===
+#first parameter: name
+ StudioInterface.getServerVariableValues('REMOTE_ADDR');
+ ''return'': the values in an array of the server variable for the current request
-=== Get secure count of all published records (7.21.07) ===
+=== Gets all the application session keys (7.25.01) ===
-#no parameters
+  StudioInterface.getAllAppSessionKeys();
-#security: this function returns the count of all published records (services and knowledge articles) and checks the current user security profile
+  ''return'': an array of strings with all the keys
-  ServiceCatalogInterface.getCountPublishedRecordsSecure();
-  ''return'': number
-=== Get secure list of all published records ===
+=== Gets an application session value (7.25.01) ===
-#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
+#first parameter: name
-#security: this function returns all published records (services and knowledge articles) and checks the current user security profile for all returning authorized records
+  StudioInterface.getAppSessionValue('name');
-  ServiceCatalogInterface.getAllPublishedRecordsSecure();
+  ''return'': the value (object)
-  ''return'':  An array of all currently published records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get secure count of published records by searching (7.21.07) ===
+=== Sets an application session value (7.25.01) ===
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+#first parameter: name
-#optional second parameter: object with LanguageId (7.22.08)
+#second parameter: value
-#security: this function returns the count of all published records (services and knowledge articles) and checks the current user security profile
+  StudioInterface.setAppSessionValue('sessionkeyname', 'sessionkeyvalue');
-  ServiceCatalogInterface.searchCountPublishedRecordsSecure({ tag: "bike" });
+  ''return'': nothing
-  ''return'': number
-=== Get secure list of published records by searching (7.21.07) ===
+=== Removes an application session object (7.25.01) ===
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+#first parameter: name
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+  StudioInterface.removeAppSession('sessionkeyname');
-#security: this function returns all published records (services and knowledge articles) and checks the current user security profile for all returning authorized records
+  ''return'': nothing
-  ServiceCatalogInterface.searchListPublishedRecordsSecure({ tag: "bike" });
- ServiceCatalogInterface.searchListPublishedRecordsSecure({ anytag: ["bike","auto"], name_contains: "transport" });
-  ''return'':  An array of all currently published records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get count of all published records (7.21.07) ===
+=== Get all keys from the cookie collection (7.22.03) ===
-#no parameters
+  StudioInterface.getAllCookieKeys();
-#security: this function returns the count of all published records (services and knowledge articles), without checking the current user security profile
+  ''return'': an array of strings with all the keys of the cookies for the current request
-  ServiceCatalogInterface.getCountPublishedRecords();
-  ''return'': number
-=== Get list of all published records ===
+=== Get a value from the cookie ===
-#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
+#first parameter: name
-#security: this function returns all published records (services and knowledge articles), without checking the current user security profile
+  StudioInterface.getCookieValue('name');
-  ServiceCatalogInterface.getAllPublishedRecords();
+  ''return'': the value (url decoded) of the cookie for the current request
-  ''return'':  An array of all currently published records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get count of published records by searching (7.21.07) ===
+=== Get a raw value from the cookie (7.24.06) ===
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+#first parameter: name
-#optional second parameter: object with LanguageId (7.22.08)
+  StudioInterface.getCookieValueRaw('name');
-#security: this function returns the count of all published records (services and knowledge articles), without checking the current user security profile
+  ''return'': the value (not url decoded) of the cookie for the current request
-  ServiceCatalogInterface.searchCountPublishedRecords({ tag: "bike" });
-  ''return'': number
-=== Get list of published records by searching (7.21.07) ===
+=== Set a cookie (7.22.03) ===
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+Adds a cookie, if no expire days is provided, then it's a session cookie (will be removed when session ends)
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#first parameter: name
-#security: this function returns published records (services and knowledge articles) that matches the search conditions, without checking the current user security profile
+#second parameter: value (will be url encoded since 7.24.06)
- ServiceCatalogInterface.searchListPublishedRecords({ tag: "bike" });
+#third parameter (optional): expire in nr of days (a negative value will remove the cookie)
-  ServiceCatalogInterface.searchListPublishedRecords({ anytag: ["bike","auto"], name_contains: "transport" });
+  StudioInterface.setCookie('cookiename', 'cookievalue');
-  ''return'':  An array of all currently published records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+  ''return'': nothing
-=== Get secure count of all published services (7.21.07) ===
+=== Set a cookie with options (7.24.10) ===
-#no parameters
+Adds a cookie using the options provided
-#security: this function returns the count of all published services and checks the current user security profile
+#first parameter: name
-  ServiceCatalogInterface.getCountPublishedServicesSecure();
+#second parameter: value (will be url encoded)
-  ''return'': number
+#third parameter: object with supported properties: httponly, path, domain, secure and expires
+  StudioInterface.setCookieWithOptions('cookiename', 'cookievalue', { "HttpOnly": false });
+  ''return'': nothing
-=== Get secure list of all published services ===
+=== Set a cookie value raw (7.24.06) ===
-#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
+Adds a cookie, if no expire days is provided, then it's a session cookie (will be removed when session ends)
-#security: this function returns all published services and checks the current user security profile
+#first parameter: name
-  ServiceCatalogInterface.getAllPublishedServicesSecure();
+#second parameter: value (will not be url encoded)
-  ''return'':  An array of all currently published services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+#third parameter (optional): expire in nr of days (a negative value will remove the cookie)
+  StudioInterface.setCookieRaw('cookiename', 'cookievalue');
+  ''return'': nothing
-=== Get secure count of published services by searching (7.21.07) ===
+=== Set a cookie value raw with options (7.24.10) ===
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+Adds a cookie using the options provided
-#optional second parameter: object with LanguageId (7.22.08)
+#first parameter: name
-#security: this function returns the count of all published services and checks the current user security profile
+#second parameter: value (will not be url encoded)
-  ServiceCatalogInterface.searchCountPublishedServicesSecure({tag: "bike"});
+#third parameter: object with supported properties: httponly, path, domain, secure and expires
-  ''return'': number
+  StudioInterface.setCookieRawWithOptions('cookiename', 'cookievalue', { "HttpOnly": false });
+  ''return'': nothing
-=== Get secure list of published services by searching (7.21.07) ===
+=== Get all keys from the posted form collection (7.22.03) ===
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+  StudioInterface.getAllFormKeys();
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+  ''return'': an array of strings with all the keys of the posted form collection for the current request
-#security: this function returns all published services and checks the current user security profile
-  ServiceCatalogInterface.searchListPublishedServicesSecure({tag: "bike"});
-  ''return'':  An array of all currently published services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get count of all published services (7.21.07) ===
+=== Get a value from the posted form collection ===
-#no parameters
+#first parameter: name
-#security: this function returns the count all published services, without checking the current user security profile
+  StudioInterface.getFormValue('name');
-  ServiceCatalogInterface.getCountPublishedServices();
+  ''return'': the value from the posted form collection for the current request
-  ''return'': number
-=== Get list of all published services ===
+=== Get values in an array from the posted form collection (7.24.03) ===
-#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
+#first parameter: name
-#security: this function returns all published services, without checking the current user security profile
+  StudioInterface.getFormValues('name');
-  ServiceCatalogInterface.getAllPublishedServices();
+  ''return'': the values in an array from the posted form collection for the current request
-  ''return'':  An array of all currently published services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get count of published services by searching (7.21.07) ===
+=== Get the http method for the current request ===
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+  StudioInterface.getHttpMethod();
-#optional second parameter: object with LanguageId (7.22.08)
+  ''return'': the current http method (GET, POST, …)
-#security: this function returns the count all published services, without checking the current user security profile
-  ServiceCatalogInterface.searchCountPublishedServices({tag: "bike"});
-  ''return'': number
-=== Get list of published services by searching (7.21.07) ===
+=== Get the content type of the current request ===
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+  StudioInterface.getContentType();
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+  ''return'': the content type (text/plain, application/json, …)
-#security: this function returns all published services, without checking the current user security profile
-  ServiceCatalogInterface.searchListPublishedServices({tag: "bike"});
-  ''return'':  An array of all currently published services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get secure count of all published knowledge articles (7.21.07) ===
+=== Get the full posted content as string ===
-#no parameters
+ StudioInterface.getPostedContent();
-#security: this function returns the count of all published knowledge articles and checks the current user security profile
+ ''return'': posted content
-  ServiceCatalogInterface.getCountPublishedKnowledgeArticlesSecure();
-  ''return'': number
+=== Check if the HTTP request has a posted file (7.23.12) ===
+#optional first parameter: allextensionsallowed - default false (7.24.10)
+  StudioInterface.hasPostedFile();
+  ''return'': true or false
-=== Get secure list of all published knowledge articles ===
+=== Get information about the posted file in the HTTP request (7.23.12) ===
-#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
+#optional first parameter: allextensionsallowed - default false (7.24.10)
-#security: this function returns all published knowledge articles and checks the current user security profile
+  StudioInterface.getPostedFileInfo();
-  ServiceCatalogInterface.getAllPublishedKnowledgeArticlesSecure();
+  ''return'': object with properties filename, contenttype and contentlength in JSON
-  ''return'':  An array of all currently published knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get secure count of published knowledge articles by searching (7.21.07) ===
+=== Get information about the multiple posted files in the HTTP request (7.24.10) ===
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+#optional first parameter: allextensionsallowed - default false
-#optional second parameter: object with LanguageId (7.22.08)
+  StudioInterface.getPostedFileInfos();
-#security: this function returns the count of all published knowledge articles and checks the current user security profile
+  ''return'': array of object with properties filename, contenttype and contentlength in JSON
-  ServiceCatalogInterface.searchCountPublishedKnowledgeArticlesSecure({tag: "bike"});
-  ''return'': number
-=== Get secure list of published knowledge articles by searching (7.21.07) ===
+=== Save a posted file (7.23.12) ===
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+#first parameter: foldername where the file should be stored
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#optional second parameter: filename to use (if empty the original one is used)
-#security: this function returns all published knowledge articles and checks the current user security profile
+#optional third parameter: allextensionsallowed - default false (7.24.10)
-  ServiceCatalogInterface.searchListPublishedKnowledgeArticlesSecure({tag: "bike"});
+  StudioInterface.savePostedFile('C:\\temp\\');
-  ''return'':  An array of all currently published knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+  ''return'': nothing
-=== Get count of all published knowledge articles (7.21.07) ===
+=== Get the posted file from the HTTP request in base64 (7.24.09) ===
-#no parameters
+#optional first parameter: allextensionsallowed - default false (7.24.10)
-#security: this function returns the count all published knowledge articles, without checking the current user security profile
+  StudioInterface.getPostedFileInBase64();
-  ServiceCatalogInterface.getCountPublishedKnowledgeArticles();
+  ''return'': the posted file in base64
-  ''return'': number
-=== Get list of all published knowledge articles ===
+=== Get the multiple posted files from the HTTP request in base64 (7.24.10) ===
-#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
+#optional first parameter: allextensionsallowed - default false
-#security: this function returns all published knowledge articles, without checking the current user security profile
+  StudioInterface.getPostedFilesInBase64();
-  ServiceCatalogInterface.getAllPublishedKnowledgeArticles();
+  ''return'': array of posted files in base64
-  ''return'':  An array of all currently published knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get count of published knowledge articles by searching (7.21.07) ===
+==== Convert posted Excel file to JSON array (since 7.25.02) ====
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+#optional parameter 1: object with possible properties: WorksheetName, OnlyUseStringType (when true, all values will be in string)
-#optional second parameter: object with LanguageId (7.22.08)
+  StudioInterface.excelAsPostedFileToJson();
-#security: this function returns the count all published knowledge articles, without checking the current user security profile
+  ''returns'': the JSON respresentation of the Excel file
-  ServiceCatalogInterface.searchCountPublishedKnowledgeArticles({tag: "bike"});
-  ''return'': number
-=== Get list of published knowledge articles by searching (7.21.07) ===
+=== Get the current language culture ===
-#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+  StudioInterface.getCurrentLanguageCulture();
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+  ''return'': the culture (nl-BE, en-GB, …)
-#security: this function returns all published knowledge articles, without checking the current user security profile
-  ServiceCatalogInterface.searchListPublishedKnowledgeArticles({tag: "bike"});
-  ''return'':  An array of all currently published knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get published service summary ===
+=== Get the current language name ===
-#first parameter: serviceguid
+  StudioInterface.getCurrentLanguageName();
-#optional second parameter: object with LanguageId (7.22.08)
+  ''return'': the name (English, Nederlands, …)
-#security: Returns a summary of the service, without checking the current user security profile
-  ServiceCatalogInterface.getPublishedServiceSummary(guid)
-  ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get secure published service summary ===
+=== Get the current language id ===
-#first parameter: serviceguid
+  StudioInterface.getCurrentLanguageId();
-#optional second parameter: object with LanguageId (7.22.08)
+  ''return'': the id (1, 2, …)
-#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getPublishedServiceSummarySecure(guid)
-  ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get multiple published services summary ===
+=== Check if there is a logged in person (7.21.07) ===
-#first parameter: array with serviceguids
+  StudioInterface.hasLoggedInPerson();
-#optional second parameter: object with LanguageId (7.22.08)
+  ''return'': true or false
-#security: Returns a summary of the service, without checking the current user security profile
-  ServiceCatalogInterface.getPublishedServicesSummary([guid1, guid2])
-  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get all published services summary (7.21.07) ===
+=== Get the logged in person (7.21.07) ===
-#optional first parameter: object with LanguageId (7.22.08)
+  StudioInterface.getLoggedInPerson();
-#security: Returns a summary of the service, without checking the current user security profile
+  ''return'': object with properties id, firstname, lastname, email, uniqueid, description and inactive in JSON
-  ServiceCatalogInterface.getAllPublishedServicesSummary()
-  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get secure multiple published services summary ===
+=== Get the id of the logged in person (7.23.08) ===
-#first parameter: array with serviceguids
+  StudioInterface.getLoggedInPersonId();
-#optional second parameter: object with LanguageId (7.22.08)
+  ''return'': the id
-#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getPublishedServicesSummarySecure([guid1, guid2])
-  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get secure all published services summary (7.21.07) ===
+=== Get the field value for the current logged in person ===
-#optional first parameter: object with LanguageId (7.22.08)
+#first parameter: fieldname
-#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+  StudioInterface.getLoggedInPersonField('FirstName');
-  ServiceCatalogInterface.getAllPublishedServicesSummarySecure()
+  ''return'': the value (Raymond, Dominic, …)
-  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+ Possible fields: UniqueId, FirstName, LastName, Email, all person extra fields defined in adapters.
-=== Get published service details ===
+=== Get the first and last name for the current logged in person ===
-#first parameter: serviceguid
+  StudioInterface.getLoggedInPersonFirstAndLastName();
-#optional second parameter: object with properties:
+  ''return'': the first and last name (Raymond Crijnen, Dominic De Vilder, …)
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
-- LanguageId (id of the language to use) (7.22.03)
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details, without checking the current user security profile
-  ServiceCatalogInterface.getPublishedServiceDetail(guid)
-  ''return'': all fields, including template fields for the given service guid
-=== Get secure published service details ===
+=== Get the description as defined in the settings for the current logged in person ===
-#first parameter: serviceguid
+  StudioInterface.getLoggedInPersonDescription();
-#optional second parameter: object with properties:
+  ''return'': the description (Raymond Crijnen (raymond@smt-x.com - CrijnenR))
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
-- LanguageId (id of the language to use) (7.22.03)
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getPublishedServiceDetailSecure(guid)
-  ''return'': all fields, including template fields for the given service guid
-=== Get multiple published services details ===
+=== Get the dateformat as defined for the current logged in person (7.22.06) ===
-#first parameter: array with serviceguids
+  StudioInterface.getLoggedInPersonDateFormat();
-#optional second parameter: object with properties:
+  ''return'': the dateformat (dd/MM/yyyy)
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
-- LanguageId (id of the language to use) (7.22.03)
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details, without checking the current user security profile
-  ServiceCatalogInterface.getPublishedServicesDetail([guid1, guid2])
-  ''return'': an array with services containing all fields, including template fields for the given service guids
-=== Get all published services details (7.21.07) ===
+=== Checks if the logged in person has the specified role ===
-#optional first parameter: object with properties:
+#first parameter: Role name
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+ StudioInterface.loggedInPersonHasRole('Name of the role');
-- LanguageId (id of the language to use) (7.22.03)
+  ''return'': true if the user has the role, false otherwise
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details, without checking the current user security profile
- ServiceCatalogInterface.getAllPublishedServicesDetail()
-  ''return'': an array with services containing all fields, including template fields
-=== Get secure multiple published services details ===
+=== Checks if the logged in person has any of the specified roles (7.21.08) ===
-#first parameter: array with serviceguids
+#first parameter: array of role names
-#optional second parameter: object with properties:
+  StudioInterface.loggedInPersonHasAnyRole(['Name of the role1', 'Name of the role2']);
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+  ''return'': true if the user has any of the roles, false otherwise
-- LanguageId (id of the language to use) (7.22.03)
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getPublishedServicesDetailSecure([guid1, guid2])
-  ''return'': an array with services containing all fields, including template fields for the given service guids
-=== Get secure all published services details (7.21.07) ===
+=== Checks if the logged in person has all of the specified roles (7.21.08) ===
-#optional first parameter: object with properties:
+#first parameter: array of role names
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+ StudioInterface.loggedInPersonHasAllRoles(['Name of the role1', 'Name of the role2']);
-- LanguageId (id of the language to use) (7.22.03)
+  ''return'': true if the user has all of the roles, false otherwise
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
- ServiceCatalogInterface.getAllPublishedServicesDetailSecure()
-  ''return'': an array with services containing all fields, including template fields
-=== Get published service part values (7.21.07) ===
+=== Checks if the logged in person is an admin (7.22.06) ===
-#first parameter: serviceguid
+  StudioInterface.loggedInPersonIsAdmin();
-#second parameter: array of internal names of the parts (pass null to get all parts)
+  ''return'': true if the user is admin, false otherwise
-#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
-#security: Returns all part values, without checking the current user security profile
-  ServiceCatalogInterface.getPublishedServiceParts(guid, ["part1", "part2"])
-  ''return'': template fields for the given service guid
-=== Get secure published service part values (7.21.07) ===
+=== Get a translation ===
-#first parameter: serviceguid
+#first parameter: Category
-#second parameter: array of internal names of the parts (pass null to get all parts)
+#second parameter: Label
-#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+  StudioInterface.translate('Common', 'Profile');
-#security: Returns all part values and checks if the current user is authorized to retrieve these details (at least read rights)
+  ''return'': the translation value for the SSP translations
-  ServiceCatalogInterface.getPublishedServicePartsSecure(guid, ["part1", "part2"])
-  ''return'': template fields for the given service guid
-=== Get multiple published services part values (7.21.07) ===
+=== Get a translation and add default value if missing (7.24.07) ===
-#first parameter: array with serviceguids
+#first parameter: Category
-#second parameter: array of internal names of the parts (pass null to get all parts)
+#second parameter: Label
-#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#third parameter: Default Value
-#security: Returns all part values, without checking the current user security profile
+  StudioInterface.translate('Common', 'Profile', 'My Profile');
-  ServiceCatalogInterface.getPublishedServicesParts([guid1, guid2], ["part1", "part2"])
+  ''return'': the translation value for the SSP translations and if it doesn't exits yet, it will be added with the default value in the default language
-  ''return'': template fields for the given service guid
-=== Get secure multiple published services details (7.21.07) ===
+=== Get the root of the ssp location ===
-#first parameter: array with serviceguids
+  StudioInterface.getSspRoot();
-#second parameter: array of internal names of the parts (pass null to get all parts)
+  ''return'': the http location, including the trailing slash (https:=== ssp/)
-#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
-#security: Returns all part values, without checking the current user security profile
-  ServiceCatalogInterface.getPublishedServicesPartsSecure([guid1, guid2], ["part1", "part2"])
-  ''return'': template fields for the given service guid
-=== Get all published services part values (7.21.07) ===
+=== Get the http path to the current application ===
-#first parameter: array of internal names of the parts (pass null to get all parts)
+  StudioInterface.getApplicationPath();
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+  ''return'': the http location, without the trailing slash (https:=== ssp/myapp)
-#security: Returns all part values for all services, without checking the current user security profile
-  ServiceCatalogInterface.getAllPublishedServicesParts(["part1", "part2"])
-  ''return'': template fields
-=== Get secure all published services details (7.21.07) ===
+=== Get the application folder name (7.22.09) ===
-#first parameter: array of internal names of the parts (pass null to get all parts)
+ StudioInterface.getApplicationFolder();
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+ ''return'': the name of the folder (eg myapp)
-#security: Returns all part values for all services and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getAllPublishedServicesPartsSecure(["part1", "part2"])
+=== Get the current folder name (full) inside the current application ===
-  ''return'': template fields
+  StudioInterface.getCurrentFolderName();
+  ''return'': the current full folder path, including the starting and trailing slash (/subfolder/content/)
-=== Search published services using text search (with Lucene) (7.21.11) ===
+=== Get the current file name inside the current application ===
-#first parameter: language id
+  StudioInterface.getCurrentName();
-#second parameter: the text to search (allows for * and ?)
+  ''return'': the current file name (index.html)
-#optional third parameter: object with properties 'itemsperpage' (default 100), 'after' (pass the object 'lastinfo' from the previous search result), 'templatename', 'templatetype' and 'servicetype'
-#security: this function returns all published services, without checking the current user security profile
-  ServiceCatalogInterface.textSearch(1, "how to ride a bike", { templatetype: "Knowledge_article" });
-  ''return'':  An object with properties 'totalhits' (total amount of hits), 'entries' (array of search result entries containing the following data: guid, name, summary, servicetype, templatename, templatetype) and 'lastinfo' (contains the needed info to fetch the next batch of results)
-=== Search secure published services using text search (with Lucene) (7.21.11) ===
+=== Get the current full path of the file inside the current application ===
-#first parameter: language id
+  StudioInterface.getCurrentPath();
-#second parameter: the text to search (allows for * and ?)
+  ''return'': the current file name (/subfolder/content/index.html)
-#optional third parameter: object with properties 'itemsperpage' (default 100), 'after' (pass the object 'lastinfo' from the previous search result), 'templatename', 'templatetype' and 'servicetype'
-#security: this function returns all published services and checks the current user security profile
-  ServiceCatalogInterface.textSearchSecure(1, "how to ride a bike", { templatetype: "Knowledge_article" });
-  ''return'':  An object with properties 'totalhits' (total amount of hits), 'entries' (array of search result entries containing the following data: guid, name, summary, servicetype, templatename, templatetype) and 'lastinfo' (contains the needed info to fetch the next batch of results)
-=== Get service version summary (7.21.12) ===
+=== Get the current full raw url (since 7.23.04) ===
-#first parameter: serviceguid
+  StudioInterface.getCurrentFullRawUrl();
-#second parameter: versionnumber
+  ''return'': the current full raw url, eg /my-app/my-folder/my-file.txt
-#optional third parameter: object with LanguageId (7.22.08)
-#security: Returns a summary of the service, without checking the current user security profile
-  ServiceCatalogInterface.getServiceVersionSummary(guid, versionnumber)
-  ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get secure service version summary (7.21.12) ===
+=== Get the current application raw url (since 7.23.04) ===
-#first parameter: serviceguid
+  StudioInterface.getCurrentApplicationRawUrl();
-#second parameter: versionnumber
+  ''return'': the current full raw url minues the application folder, eg /my-folder/my-file.txt
-#optional third parameter: object with LanguageId (7.22.08)
-#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getServiceVersionSummarySecure(guid, versionnumber)
-  ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get service version details (7.21.12) ===
+=== Get the current application id (7.22.06) ===
-#first parameter: serviceguid
+  StudioInterface.getCurrentApplicationId();
-#second parameter: versionnumber
+  ''return'': the id of the application
-#optional third parameter: object with properties:
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
-- LanguageId (id of the language to use) (7.22.03)
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details, without checking the current user security profile
-  ServiceCatalogInterface.getServiceVersionDetail(guid, versionnumber)
-  ''return'': all fields, including template fields for the given service guid and versionnumber
-=== Get secure service version details (7.21.12) ===
+=== Get the ticks of the last modified date of the current application (7.23.02) ===
-#first parameter: serviceguid
+  StudioInterface.getCurrentApplicationLastModifiedTicks();
-#second parameter: versionnumber
+  ''return'': the ticks of the last modified date of the application
-#optional third parameter: object with properties:
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
-- LanguageId (id of the language to use) (7.22.03)
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getServiceVersionDetailSecure(guid, versionnumber)
-  ''return'': all fields, including template fields for the given service guid and versionnumber
-=== Get secure count of all records (7.21.12) ===
+=== renders the application file as a string ===
-#no parameters
+#first parameter: string to be rendered
-#security: this function returns the count of all records (services and knowledge articles) and checks the current user security profile
+  StudioInterface.renderAsString('/subfolder/content/index.html');
-  ServiceCatalogInterface.getCountRecordsSecure();
+  ''return'': the rendered content
-  ''return'': number
-=== Get secure list of all records (7.21.12) ===
+=== renders the application file as a string, passing thru the parameters to the rendering script ===
-#optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#first parameter: Application file
-#security: this function returns all records (services and knowledge articles) and checks the current user security profile for all returning authorized records
+#second parameter: object with parameters
-  ServiceCatalogInterface.getAllRecordsSecure();
+  StudioInterface.renderAsStringWithParameters('/subfolder/content/index.html', { 'Title': 'My title', 'Summary': 'My summary' });
-  ''return'':  An array of all currently records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+  ''return'': the rendered content (the parameters are accessible in the processing script of the file to render, use g_parameters)
-=== Get count of all records (7.21.12) ===
+=== renders the application file and returns the rendered object ===
-#no parameters
+#first parameter: Application file
-#security: this function returns the count of all records (services and knowledge articles), without checking the current user security profile
+ StudioInterface.render('/subfolder/content/index.html');
-  ServiceCatalogInterface.getCountRecords();
+ ''return'': the rendered object with these properties: action, content, contenttype, templatezones, templateparameters
-  ''return'': number
+=== renders the application file, passing thru the parameters to the rendering script ===
+  StudioInterface.renderWithParameters('/subfolder/content/index.html', { 'Title': 'My title', 'Summary': 'My summary' });
+  ''return'': the rendered object (see .render for details)
-=== Get list of all records (7.21.12) ===
+=== Get the value for the application variable ===
-#optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#first parameter: Variable name
-#security: this function returns all records (services and knowledge articles), without checking the current user security profile
+  StudioInterface.getVariableValue('my variable');
-  ServiceCatalogInterface.getAllRecords();
+  ''return'': the value (type is depending on the variable)
-  ''return'':  An array of all currently records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get secure count of all services (7.21.12) ===
+=== Get the value for the application variable, passing thru the parameters to the variable script ===
-#no parameters
+#first parameter: Variable name
-#security: this function returns the count of all services and checks the current user security profile
+#second parameter: object with parameters (passed through to the variable script)
-  ServiceCatalogInterface.getCountServicesSecure();
+  StudioInterface.getVariableValueWithParameters('my custom variable function', { 'Number': 8 });
-  ''return'': number
+  ''return'': the value (type is depending on the variable)
-=== Get secure list of all services (7.21.12) ===
+=== Get the value for the application setting (7.24.12) ===
-#optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#first parameter: Setting name
-#security: this function returns all services and checks the current user security profile
+  StudioInterface.getSettingValue('my setting');
-  ServiceCatalogInterface.getAllServicesSecure();
+  ''return'': the value (type is depending on the setting)
-  ''return'':  An array of all currently services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get count of all services (7.21.12) ===
+=== Get the value for the application setting, passing thru the parameters to the setting script (7.24.12) ===
-#no parameters
+#first parameter: Setting name
-#security: this function returns the count all services, without checking the current user security profile
+#second parameter: object with parameters (passed through to the setting script)
-  ServiceCatalogInterface.getCountServices();
+  StudioInterface.getSettingValueWithParameters('my custom setting function', { 'Number': 8 });
-  ''return'': number
+  ''return'': the value (type is depending on the setting)
-=== Get list of all services (7.21.12) ===
+=== Schedule a studio task to run on the next SSP Scheduler run (7.23.07) ===
-#optional first parameter: object with LanguageId (7.22.08)
+#first parameter: name of the task
-#security: this function returns all services, without checking the current user security profile
+  StudioInterface.scheduleStudioTaskToRunOnNextSchedulerRun('my task');
-  ServiceCatalogInterface.getAllServices();
+  ''return'': nothing
-  ''return'':  An array of all currently services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get secure count of all knowledge articles (7.21.12) ===
+=== Views (7.22.06) ===
-#no parameters
+==== getViewCountByName ====
-#security: this function returns the count of all knowledge articles and checks the current user security profile
+Get the count of a view by it's name
-  ServiceCatalogInterface.getCountKnowledgeArticlesSecure();
+#first parameter is the name of the view
-  ''return'': number
+#optional second parameter can be an object with properties "GetFromSource" or "AllowDbAccess"
+  StudioInterface.getViewCountByName("view1");
+  ''returns'': the count of the view
-=== Get secure list of all knowledge articles (7.21.12) ===
+==== getCachedViewCountByName (7.24.07) ====
-#optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+Get the count of a view by it's name only by fetching it from the cache
-#security: this function returns all knowledge articles and checks the current user security profile
+#first parameter is the name of the view
-  ServiceCatalogInterface.getAllKnowledgeArticlesSecure();
+  StudioInterface.getViewCountByName("view1");
-  ''return'':  An array of all currently knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+  ''returns'': the count of the view if it's found in the cache, null otherwise
-=== Get count of all knowledge articles (7.21.12) ===
+==== getViewCountById ====
-#no parameters
+Get the count of a view by it's id
-#security: this function returns the count all knowledge articles, without checking the current user security profile
+#first parameter is the id of the view
-  ServiceCatalogInterface.getCountKnowledgeArticles();
+#optional second parameter can be an object with properties "GetFromSource" or "AllowDbAccess"
-  ''return'': number
+  StudioInterface.getViewCountById(1);
+  ''returns'': the count of the view
-=== Get list of all knowledge articles (7.21.12) ===
+==== getCachedViewCountById (7.24.07) ====
-#optional first parameter: object with LanguageId (7.22.08)
+Get the count of a view by it's id only by fetching it from the cache
-#security: this function returns all knowledge articles, without checking the current user security profile
+#first parameter is the id of the view
-  ServiceCatalogInterface.getAllKnowledgeArticles();
+  StudioInterface.getViewCountById(1);
-  ''return'':  An array of all currently knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+  ''returns'': the count of the view if found in cache, null otherwise
-=== Get secure count of all records (7.22.04) ===
+==== getViewDataByName ====
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
+Get the data of a view by it's name
-#security: this function returns the count of all records based on the search criteria (services and knowledge articles) and checks the current user security profile
+#first parameter is the name of the view
-  ServiceCatalogInterface.searchCountRecordsSecure(searchcriteria);
+ StudioInterface.getViewDataByName("view1");
-  ''return'': number
+ ''returns'': the data of the view in JSON
+==== searchViewDataByName (7.22.08) ====
+Search the data of a view by it's name
+#first parameter is the name of the view
+#second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum. Update since 7.23.05: extra possible property: Connector and Filters, extra FilterOperator: SubFilter
+#optional third parameter is an object with properties PageIndex, PageSize, OrderBy
+  StudioInterface.searchViewDataByName("view1", [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
+  ''returns'': the data of the search results in JSON
-=== Get secure list of all records (7.22.04) ===
+==== getViewDataByNames ====
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
+Get the data of multiple views by their names
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#first parameter is an array of the name of the views
-#security: this function returns all records based on the search criteria (services and knowledge articles) and checks the current user security profile for all returning authorized records
+  StudioInterface.getViewDataByNames(["view1", "view2"]);
-  ServiceCatalogInterface.searchAllRecordsSecure(searchcriteria);
+  ''returns'': the data of the views in JSON
-  ''return'':  An array of all currently records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== searchViewDataByNames (7.22.08) ====
-=== Get count of all records (7.22.04) ===
+Search the data of a view by their names
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
+#first parameter is an array of the name of the views
-#security: this function returns the count of all records based on the search criteria (services and knowledge articles), without checking the current user security profile
+#second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum. Update since 7.23.05: extra possible property: Connector and Filters, extra FilterOperator: SubFilter
- ServiceCatalogInterface.searchCountRecords(searchcriteria);
+#optional third parameter is an object with properties PageIndex, PageSize, OrderBy
-  ''return'': number
+ StudioInterface.searchViewDataByName(["view1", "view2"], [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
+  ''returns'': the data of the search results in JSON
-=== Get list of all records (7.22.04) ===
+==== getViewDataForTicketsByName ====
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
+Search for tickets and get the results back as defined in the view by the views name
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#first parameter is the name of the view
-#security: this function returns all records based on the search criteria (services and knowledge articles), without checking the current user security profile
+#second parameter is an object with the search predicates (possible properties are "CustomKey", "Id", "Status", "Keywords", "RequestorId", "DateStartedFrom", "DateStartedTo", "DateEndedFrom", "DateEndedTo")
-  ServiceCatalogInterface.searchAllRecords(searchcriteria);
+#optional third parameter is an object with the paging settings
-  ''return'':  An array of all currently records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+  StudioInterface.getViewDataForTicketsByName("view1", { "Status": "Open" });
+  ''returns'': the tickets formatted as defined in the view in JSON
-=== Search secure count of all services (7.22.04) ===
+==== getViewDataById ====
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
+Get the data of a view by it's id
-#security: this function returns the count of all services based on the search criteria and checks the current user security profile
+#first parameter is the id of the view
-  ServiceCatalogInterface.searchCountServicesSecure(searchcriteria);
+ StudioInterface.getViewDataById(1);
-  ''return'': number
+ ''returns'': the data of the view in JSON
+==== searchViewDataById (7.22.08) ====
+Get the data of a view by it's id
+#first parameter is the id of the view
+#second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum. Update since 7.23.05: extra possible property: Connector and Filters, extra FilterOperator: SubFilter
+#optional third parameter is an object with properties PageIndex, PageSize, OrderBy
+  StudioInterface.searchViewDataById(1, [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
+  ''returns'': the data of the search results in JSON
-=== Search secure list of all services (7.22.04) ===
+==== getViewDataByIds ====
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
+Get the data of multiple views by their ids
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#first parameter is an array of ids of the views
-#security: this function returns all services based on the search criteria and checks the current user security profile
+ StudioInterface.getViewDataByIds([1, 2]);
- ServiceCatalogInterface.searchAllServicesSecure(searchcriteria);
+ ''returns'': the data of the views in JSON
- ''return'':  An array of all currently services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== searchViewDataByIds (7.22.08) ====
+Get the data of multiple views by their ids
+#first parameter is an array of ids of the views
+#second parameter is an array of objects with possible properties: FieldName, FilterOperator and FilterValue. Possible FilterOperators are: Contains, DoesNotContain, StartsWith, EndsWith, EqualTo, NotEqualTo, EqualToNum, NotEqualToNum, GreaterThanNum, LessThanNum, BetweenNum, GreaterThanDate, LessThanDate, BetweenDate, EqualToDate, NotEqualToDate, ContainsAny, ContainsAnyNum. Update since 7.23.05: extra possible property: Connector and Filters, extra FilterOperator: SubFilter
+#optional third parameter is an object with properties PageIndex, PageSize, OrderBy
+ StudioInterface.searchViewDataByName([1, 2], [ { FieldName: "field1", FilterOperator: "NotEqualTo", FilterValue: "test" } ]);
+ ''returns'': the data of the search results in JSON
-=== Search count of all services (7.22.04) ===
+==== getViewDataForTicketsById ====
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
+Search for tickets and get the results back as defined in the view by the views id
-#security: this function returns the count all services based on the search criteria, without checking the current user security profile
+#first parameter is the id of the view
-  ServiceCatalogInterface.searchCountServices(searchcriteria);
+#second parameter is an object with the search predicates (possible properties are "CustomKey", "Id", "Status", "Keywords", "RequestorId", "DateStartedFrom", "DateStartedTo", "DateEndedFrom", "DateEndedTo")
-  ''return'': number
+#optional third parameter is an object with the paging settings
+  StudioInterface.getViewDataForTicketsById(1, { "Status": "Open" });
+  ''returns'': the tickets formatted as defined in the view in JSON
-=== Search list of all services (7.22.04) ===
+=== Quick Requests (7.24.07) ===
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
+==== Get the quick requests ====
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+Get all the quick requests
-#security: this function returns all services based on the search criteria, without checking the current user security profile
+  CommonInterface.getQuickRequests();
-  ServiceCatalogInterface.searchAllServices(searchcriteria);
+  ''returns'': array of object with properties id, typeid, typename, iconurl, cssclass, name and url in JSON
-  ''return'':  An array of all currently services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
- ''example criteria'': { templatename: ["Template 1", "Template 2"] }
- '' available criteria: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes
-=== Search secure count of all knowledge articles (7.22.04) ===
+==== Get the quick requests SECURE ====
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
+Get the quick requests for the logged in user
-#security: this function returns the count of all knowledge articles based on the search criteria and checks the current user security profile
+  CommonInterface.getQuickRequestsSecure();
-  ServiceCatalogInterface.searchCountKnowledgeArticlesSecure(searchcriteria);
+  ''returns'': array of object with properties id, typeid, typename, iconurl, cssclass, name and url in JSON
-  ''return'': number
-=== Search secure list of all knowledge articles (7.22.04) ===
+== Service Catalog Interface ==
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
-#security: this function returns all knowledge articles based on the search criteria and checks the current user security profile
- ServiceCatalogInterface.searchAllKnowledgeArticlesSecure(searchcriteria);
- ''return'':  An array of all currently knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Search count of all knowledge articles (7.22.04) ===
+=== General ===
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
+==== Rebuild the search indexes (7.23.07) ====
-#security: this function returns the count all knowledge articles based on the search criteria, without checking the current user security profile
+#no parameters
-  ServiceCatalogInterface.searchCountKnowledgeArticles(searchcriteria);
+ ServiceCatalogInterface.rebuildSearchIndexes();
+ ''return'': nothing
+==== Get the quality note types (7.23.07) ====
+#optional first parameters is an object possible key LanguageId
+ ServiceCatalogInterface.getQualityNoteTypes();
+ ''return'': array of objects with properties guid, canselectreviewcycle and name
+=== Published versions ===
+==== Get secure count of all published records (7.21.07) ====
+#no parameters
+#security: this function returns the count of all published records (services and knowledge articles) and checks the current user security profile
+  ServiceCatalogInterface.getCountPublishedRecordsSecure();
   ''return'': number
-=== Search list of all knowledge articles (7.22.04) ===
+==== Get secure list of all published records ====
-#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes)
+#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all published records (services and knowledge articles) and checks the current user security profile for all returning authorized records
-#security: this function returns all knowledge articles based on the search criteria, without checking the current user security profile
+  ServiceCatalogInterface.getAllPublishedRecordsSecure();
-  ServiceCatalogInterface.searchAllKnowledgeArticles(searchcriteria);
+  ''return'':  An array of all currently published records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-  ''return'':  An array of all currently knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get service summary (7.21.12) ===
+==== Get secure count of published records by searching (7.21.07) ====
-#first parameter: serviceguid
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
-#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#optional second parameter: object with LanguageId (7.22.08)
-#security: Returns a summary of the service, without checking the current user security profile
+#security: this function returns the count of all published records (services and knowledge articles) and checks the current user security profile
-  ServiceCatalogInterface.getServiceSummary(guid)
+  ServiceCatalogInterface.searchCountPublishedRecordsSecure({ tag: "bike" });
-  ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+  ''return'': number
-=== Get secure service summary (7.21.12) ===
+==== Get secure list of published records by searching (7.21.07) ====
-#first parameter: serviceguid
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
 #optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
-#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+#security: this function returns all published records (services and knowledge articles) and checks the current user security profile for all returning authorized records
-  ServiceCatalogInterface.getServiceSummarySecure(guid)
+ ServiceCatalogInterface.searchListPublishedRecordsSecure({ tag: "bike" });
-  ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+  ServiceCatalogInterface.searchListPublishedRecordsSecure({ anytag: ["bike","auto"], name_contains: "transport" });
+  ''return'':  An array of all currently published records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Get count of all published records (7.21.07) ====
+#no parameters
+#security: this function returns the count of all published records (services and knowledge articles), without checking the current user security profile
+ ServiceCatalogInterface.getCountPublishedRecords();
+ ''return'': number
-=== Get multiple services summary (7.21.12) ===
+==== Get list of all published records ====
-#first parameter: array with serviceguids
+#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
-#security: Returns a summary of the service, without checking the current user security profile
+#security: this function returns all published records (services and knowledge articles), without checking the current user security profile
-  ServiceCatalogInterface.getServicesSummary([guid1, guid2])
+  ServiceCatalogInterface.getAllPublishedRecords();
-  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+  ''return'':  An array of all currently published records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get all services summary (7.21.12) ===
+==== Get count of published records by searching (7.21.07) ====
-#optional first parameter: object with LanguageId (7.22.08)
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
-#security: Returns a summary of the service, without checking the current user security profile
+#optional second parameter: object with LanguageId (7.22.08)
-  ServiceCatalogInterface.getAllServicesSummary()
+#security: this function returns the count of all published records (services and knowledge articles), without checking the current user security profile
-  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+  ServiceCatalogInterface.searchCountPublishedRecords({ tag: "bike" });
+  ''return'': number
-=== Get secure multiple services summary (7.21.12) ===
+==== Get list of published records by searching (7.21.07) ====
-#first parameter: array with serviceguids
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
 #optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
-#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+#security: this function returns published records (services and knowledge articles) that matches the search conditions, without checking the current user security profile
-  ServiceCatalogInterface.getServicesSummarySecure([guid1, guid2])
+ ServiceCatalogInterface.searchListPublishedRecords({ tag: "bike" });
-  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+  ServiceCatalogInterface.searchListPublishedRecords({ anytag: ["bike","auto"], name_contains: "transport" });
+  ''return'':  An array of all currently published records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get secure all services summary (7.21.12) ===
+==== Get secure count of all published services (7.21.07) ====
-#optional first parameter: object with LanguageId (7.22.08)
+#no parameters
-#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+#security: this function returns the count of all published services and checks the current user security profile
-  ServiceCatalogInterface.getAllServicesSummarySecure()
+  ServiceCatalogInterface.getCountPublishedServicesSecure();
-  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+  ''return'': number
-=== Get service details (7.21.12) ===
+==== Get secure list of all published services ====
-#first parameter: serviceguid
+#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
-#optional second parameter: object with properties:
+#security: this function returns all published services and checks the current user security profile
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+  ServiceCatalogInterface.getAllPublishedServicesSecure();
-- LanguageId (id of the language to use) (7.22.03)
+  ''return'':  An array of all currently published services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details, without checking the current user security profile
-  ServiceCatalogInterface.getServiceDetail(guid)
-  ''return'': all fields, including template fields for the given service guid
- Please note that there is an optional parameter to retrieve the service details in a specific languange. Use this: ServiceCatalogInterface.getServiceDetail(guid, { LanguageId: 1 }) to get the service details in the language English. (1=English, 2=Dutch, 3=French, 4=German).
-=== Get secure service details (7.21.12) ===
+==== Get secure count of published services by searching (7.21.07) ====
-#first parameter: serviceguid
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
-#optional second parameter: object with properties:
+#optional second parameter: object with LanguageId (7.22.08)
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+#security: this function returns the count of all published services and checks the current user security profile
-- LanguageId (id of the language to use) (7.22.03)
+  ServiceCatalogInterface.searchCountPublishedServicesSecure({tag: "bike"});
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+  ''return'': number
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getServiceDetailSecure(guid)
-  ''return'': all fields, including template fields for the given service guid
-=== Get multiple services details (7.21.12) ===
+==== Get secure list of published services by searching (7.21.07) ====
-#first parameter: array with serviceguids
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
-#optional second parameter: object with properties:
+#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+#security: this function returns all published services and checks the current user security profile
-- LanguageId (id of the language to use) (7.22.03)
+  ServiceCatalogInterface.searchListPublishedServicesSecure({tag: "bike"});
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+  ''return'':  An array of all currently published services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details, without checking the current user security profile
-  ServiceCatalogInterface.getServicesDetail([guid1, guid2])
-  ''return'': an array with services containing all fields, including template fields for the given service guids
-=== Get all services details (7.21.12) ===
+==== Get count of all published services (7.21.07) ====
-#optional second parameter: object with properties:
+#no parameters
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+#security: this function returns the count all published services, without checking the current user security profile
-- LanguageId (id of the language to use) (7.22.03)
+  ServiceCatalogInterface.getCountPublishedServices();
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+  ''return'': number
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details, without checking the current user security profile
-  ServiceCatalogInterface.getAllServicesDetail()
-  ''return'': an array with services containing all fields, including template fields
-=== Get secure multiple services details (7.21.12) ===
+==== Get list of all published services ====
-#first parameter: array with serviceguids
+#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
-#optional second parameter: object with properties:
+#security: this function returns all published services, without checking the current user security profile
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+  ServiceCatalogInterface.getAllPublishedServices();
-- LanguageId (id of the language to use) (7.22.03)
+  ''return'':  An array of all currently published services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getServicesDetailSecure([guid1, guid2])
-  ''return'': an array with services containing all fields, including template fields for the given service guids
-=== Get secure all services details (7.21.12) ===
+==== Get count of published services by searching (7.21.07) ====
-#optional second parameter: object with properties:
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
-- SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+#optional second parameter: object with LanguageId (7.22.08)
-- LanguageId (id of the language to use) (7.22.03)
+#security: this function returns the count all published services, without checking the current user security profile
-- PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+  ServiceCatalogInterface.searchCountPublishedServices({tag: "bike"});
-- BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+  ''return'': number
-- PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
-#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getAllServicesDetailSecure()
-  ''return'': an array with services containing all fields, including template fields
-=== Get service part values (7.22.02) ===
+==== Get list of published services by searching (7.21.07) ====
-#first parameter: serviceguid
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
-#second parameter: array of internal names of the parts (pass null to get all parts)
+#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
-#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: this function returns all published services, without checking the current user security profile
-#security: Returns all part values, without checking the current user security profile
+  ServiceCatalogInterface.searchListPublishedServices({tag: "bike"});
-  ServiceCatalogInterface.getServiceParts(guid, ["part1", "part2"])
+  ''return'':  An array of all currently published services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-  ''return'': template fields for the given service guid
-=== Get secure service part values (7.22.02) ===
+==== Get secure count of all published knowledge articles (7.21.07) ====
-#first parameter: serviceguid
+#no parameters
-#second parameter: array of internal names of the parts (pass null to get all parts)
+#security: this function returns the count of all published knowledge articles and checks the current user security profile
-#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+  ServiceCatalogInterface.getCountPublishedKnowledgeArticlesSecure();
-#security: Returns all part values and checks if the current user is authorized to retrieve these details (at least read rights)
+  ''return'': number
-  ServiceCatalogInterface.getServicePartsSecure(guid, ["part1", "part2"])
-  ''return'': template fields for the given service guid
-=== Get multiple services part values (7.22.02) ===
+==== Get secure list of all published knowledge articles ====
-#first parameter: array with serviceguids
+#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
-#second parameter: array of internal names of the parts (pass null to get all parts)
+#security: this function returns all published knowledge articles and checks the current user security profile
-#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+  ServiceCatalogInterface.getAllPublishedKnowledgeArticlesSecure();
-#security: Returns all part values, without checking the current user security profile
+  ''return'':  An array of all currently published knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-  ServiceCatalogInterface.getServicesParts([guid1, guid2], ["part1", "part2"])
-  ''return'': template fields for the given service guid
-=== Get secure multiple services part values (7.22.02) ===
+==== Get secure count of published knowledge articles by searching (7.21.07) ====
-#first parameter: array with serviceguids
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
-#second parameter: array of internal names of the parts (pass null to get all parts)
+#optional second parameter: object with LanguageId (7.22.08)
-#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: this function returns the count of all published knowledge articles and checks the current user security profile
-#security: Returns all part values and checks if the current user is authorized to retrieve these details (at least read rights)
+  ServiceCatalogInterface.searchCountPublishedKnowledgeArticlesSecure({tag: "bike"});
-  ServiceCatalogInterface.getServicesPartsSecure([guid1, guid2], ["part1", "part2"])
+  ''return'': number
-  ''return'': template fields for the given service guid
-=== Get all services part values (7.22.02) ===
+==== Get secure list of published knowledge articles by searching (7.21.07) ====
-#first parameter: array of internal names of the parts (pass null to get all parts)
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
-#security: Returns all part values for all services, without checking the current user security profile
+#security: this function returns all published knowledge articles and checks the current user security profile
-  ServiceCatalogInterface.getAllServicesParts(["part1", "part2"])
+  ServiceCatalogInterface.searchListPublishedKnowledgeArticlesSecure({tag: "bike"});
-  ''return'': template fields
+  ''return'':  An array of all currently published knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get secure all services part values (7.22.02) ===
+==== Get count of all published knowledge articles (7.21.07) ====
-#first parameter: array of internal names of the parts (pass null to get all parts)
+#no parameters
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: this function returns the count all published knowledge articles, without checking the current user security profile
-#security: Returns all part values for all services and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getCountPublishedKnowledgeArticles();
-  ServiceCatalogInterface.getAllServicesPartsSecure(["part1", "part2"])
+ ''return'': number
-  ''return'': template fields
+==== Get list of all published knowledge articles ====
+#optional first parameter: object with properties itemsperpage and pageindex (7.21.07) or languageid (7.22.08)
+#security: this function returns all published knowledge articles, without checking the current user security profile
+ ServiceCatalogInterface.getAllPublishedKnowledgeArticles();
+ ''return'':  An array of all currently published knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Get count of published knowledge articles by searching (7.21.07) ====
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+#optional second parameter: object with LanguageId (7.22.08)
+#security: this function returns the count all published knowledge articles, without checking the current user security profile
+  ServiceCatalogInterface.searchCountPublishedKnowledgeArticles({tag: "bike"});
+ ''return'': number
+==== Get list of published knowledge articles by searching (7.21.07) ====
+#first parameter: object with properties template, type, tag, anytag, alltags, name, name_contains, provider, receiver, provider_startswith, receiver_startswith, owner, ownerdeputy, manager or ownerorownerdeputyormanager
+#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all published knowledge articles, without checking the current user security profile
+ ServiceCatalogInterface.searchListPublishedKnowledgeArticles({tag: "bike"});
+  ''return'':  An array of all currently published knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
-=== Get service review cycles (7.22.04) ===
+==== Get published service overview (7.24.02) ====
 #first parameter: serviceguid
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#optional second parameter: object with LanguageId
-#security: Returns all review cycles, without checking the current user security profile
+#security: Returns a overview of the service, without checking the current user security profile
-  ServiceCatalogInterface.getServiceReviewCycles(guid)
+  ServiceCatalogInterface.getPublishedServiceOverview(guid)
-  ''return'': all review cycles for the given service guid
+  ''return'': the same fields as the list method returns
-=== Get secure service review cycles (7.22.04) ===
+==== Get secure published service overview (7.24.02) ====
 #first parameter: serviceguid
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#optional second parameter: object with LanguageId
-#security: Returns all review cycles and checks if the current user is authorized to retrieve these details (at least read rights)
+#security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getServiceReviewCyclesSecure(guid)
+  ServiceCatalogInterface.getPublishedServiceOverviewSecure(guid)
-  ''return'': all review cycles for the given service guid
+  ''return'': the same fields as the list method returns
-=== Get multiple services review cycles (7.22.04) ===
+==== Get multiple published services overview (7.24.02) ====
 #first parameter: array with serviceguids
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#optional second parameter: object with LanguageId
-#security: Returns all review cycles, without checking the current user security profile
+#security: Returns a overview of the service, without checking the current user security profile
-  ServiceCatalogInterface.getServicesReviewCycles([guid1, guid2])
+  ServiceCatalogInterface.getPublishedServicesOverview([guid1, guid2])
-  ''return'': all review cycles for the given service guids
+  ''return'': an array with services containing the same fields as the list method returns
-=== Get secure multiple services review cycles (7.22.04) ===
+==== Get all published services overview (7.24.02) ====
+#optional first parameter: object with LanguageId
+#security: Returns a overview of the service, without checking the current user security profile
+ ServiceCatalogInterface.getAllPublishedServicesOverview()
+ ''return'': an array with services containing the same fields as the list method returns
+==== Get secure multiple published services overview (7.24.02) ====
 #first parameter: array with serviceguids
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#optional second parameter: object with LanguageId
-#security: Returns all review cycles and checks if the current user is authorized to retrieve these details (at least read rights)
+#security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getServicesReviewCyclesSecure([guid1, guid2])
+  ServiceCatalogInterface.getPublishedServicesOverviewSecure([guid1, guid2])
-  ''return'': all review cycles for the given service guids
+  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get all services review cycles (7.22.04) ===
+==== Get secure all published services overview (7.24.02) ====
-#optional first parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#optional first parameter: object with LanguageId
-#security: Returns all review cycles for all services, without checking the current user security profile
+#security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getAllServicesReviewCycles()
+  ServiceCatalogInterface.getAllPublishedServicesOverviewSecure()
-  ''return'': all review cycles
+  ''return'': an array with services containing the same fields as the list method returns
-=== Get secure all services review cycles (7.22.04) ===
+==== Get published service summary ====
-#optional first parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#first parameter: serviceguid
-#security: Returns all review cycles for all services and checks if the current user is authorized to retrieve these details (at least read rights)
+#optional second parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
-  ServiceCatalogInterface.getAllServicesReviewCyclesSecure()
+#security: Returns a summary of the service, without checking the current user security profile
-  ''return'': all review cycles
+  ServiceCatalogInterface.getPublishedServiceSummary(guid)
+  ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get review cycle (7.22.04) ===
+==== Get secure published service summary ====
-#first parameter: reviewcycleguid
+#first parameter: serviceguid
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#optional second parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
-#security: Returns the review cycle, without checking the current user security profile
+#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getReviewCycle(reviewcycleguid)
+  ServiceCatalogInterface.getPublishedServiceSummarySecure(guid)
-  ''return'': the review cycle
+  ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get secure review cycles (7.22.04) ===
+==== Get multiple published services summary ====
-#first parameter: reviewcycleguid
+#first parameter: array with serviceguids
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#optional second parameter: object with LanguageId (7.22.08)
-#security: Returns the review cycle and checks if the current user is authorized to retrieve these details (at least read rights)
+#security: Returns a summary of the service, without checking the current user security profile
-  ServiceCatalogInterface.getReviewCycleSecure(reviewcycleguid)
+  ServiceCatalogInterface.getPublishedServicesSummary([guid1, guid2])
-  ''return'': the review cycle
+  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get multiple review cycles (7.22.04) ===
+==== Get all published services summary (7.21.07) ====
-#first parameter: array with reviewcycleguids
+#optional first parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns a summary of the service, without checking the current user security profile
-#security: Returns all review cycles, without checking the current user security profile
+  ServiceCatalogInterface.getAllPublishedServicesSummary()
-  ServiceCatalogInterface.getReviewCycles([guid1, guid2])
+  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-  ''return'': the review cycles
-=== Get secure multiple review cycles (7.22.04) ===
+==== Get secure multiple published services summary ====
-#first parameter: array with reviewcycleguids
+#first parameter: array with serviceguids
-#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#optional second parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
-#security: Returns all review cycles and checks if the current user is authorized to retrieve these details (at least read rights)
+#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
-  ServiceCatalogInterface.getReviewCyclesSecure([guid1, guid2])
+  ServiceCatalogInterface.getPublishedServicesSummarySecure([guid1, guid2])
-  ''return'': the review cycles
+  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-=== Get service variable value secure (7.22.07) ===
+==== Get secure all published services summary (7.21.07) ====
-#first parameter: service guid
+#optional first parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
-#second parameter: variable name
+#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
-#security: Checks if the current user is authorized to retrieve these details (at least read rights)
+  ServiceCatalogInterface.getAllPublishedServicesSummarySecure()
-  ServiceCatalogInterface.getServiceVariableValueSecure(guid, variablename)
+  ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
-  ''return'': the value (string)
-=== Get service variable value (7.22.07) ===
+==== Get published service details ====
-#first parameter: service guid
+#first parameter: serviceguid
-#second parameter: variable name
+#optional second parameter: object with properties:
-#security: No checks are done
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
-  ServiceCatalogInterface.getServiceVariableValue(guid, variablename)
+ - LanguageId (id of the language to use) (7.22.03)
-  ''return'': the value (string)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details, without checking the current user security profile
+  ServiceCatalogInterface.getPublishedServiceDetail(guid)
+  ''return'': all fields, including template fields for the given service guid
-=== Set service variable value secure (7.22.07) ===
+==== Get secure published service details ====
-#first parameter: service guid
+#first parameter: serviceguid
-#second parameter: variable name
+#optional second parameter: object with properties:
-#third parameter: variable value
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
-#security: Checks if the current user is authorized to retrieve these details (at least read rights)
+ - LanguageId (id of the language to use) (7.22.03)
-  ServiceCatalogInterface.setServiceVariableValueSecure(guid, variablename, variablevalue)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-  ''return'': nothing
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
+  ServiceCatalogInterface.getPublishedServiceDetailSecure(guid)
+  ''return'': all fields, including template fields for the given service guid
-=== Set service variable value (7.22.07) ===
+==== Get multiple published services details ====
-#first parameter: service guid
+#first parameter: array with serviceguids
-#second parameter: variable name
+#optional second parameter: object with properties:
-#third parameter: variable value
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
-#security: No checks are done
+ - LanguageId (id of the language to use) (7.22.03)
-  ServiceCatalogInterface.setServiceVariableValue(guid, variablename, variablevalue)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
-  ''return'': nothing
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details, without checking the current user security profile
+  ServiceCatalogInterface.getPublishedServicesDetail([guid1, guid2])
+  ''return'': an array with services containing all fields, including template fields for the given service guids
-=== Get service variables secure (7.22.07) ===
+==== Get all published services details (7.21.07) ====
-#first parameter: service guid
+#optional first parameter: object with properties:
-#security: Checks if the current user is authorized to retrieve these details (at least read rights)
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
-  ServiceCatalogInterface.getServiceVariablesSecure(guid)
+ - LanguageId (id of the language to use) (7.22.03)
-  ''return'': array of variables in JSON (properties: serviceguid, name, value)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details, without checking the current user security profile
+  ServiceCatalogInterface.getAllPublishedServicesDetail()
+  ''return'': an array with services containing all fields, including template fields
-=== Get service variables (7.22.07) ===
+==== Get secure multiple published services details ====
-#first parameter: service guid
+#first parameter: array with serviceguids
-#security: No checks are done
+#optional second parameter: object with properties:
-  ServiceCatalogInterface.getServiceVariables(guid)
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
-  ''return'': array of variables in JSON (properties: serviceguid, name, value)
+ - LanguageId (id of the language to use) (7.22.03)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
+  ServiceCatalogInterface.getPublishedServicesDetailSecure([guid1, guid2])
+  ''return'': an array with services containing all fields, including template fields for the given service guids
-=== Get services variables secure (7.22.07) ===
+==== Get secure all published services details (7.21.07) ====
-#first parameter: array of service guids
+#optional first parameter: object with properties:
-#security: Checks if the current user is authorized to retrieve these details (at least read rights)
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
-  ServiceCatalogInterface.getServicesVariablesSecure([guid1, guid2])
+ - LanguageId (id of the language to use) (7.22.03)
-  ''return'': array of variables in JSON (properties: serviceguid, name, value)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
+  ServiceCatalogInterface.getAllPublishedServicesDetailSecure()
+  ''return'': an array with services containing all fields, including template fields
-=== Get services variables (7.22.07) ===
+==== Get published service part values (7.21.07) ====
-#first parameter: array of service guids
+#first parameter: serviceguid
-#security: No checks are done
+#second parameter: array of internal names of the parts (pass null to get all parts)
-  ServiceCatalogInterface.getServicesVariables([guid1, guid2])
+#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
-  ''return'': array of variables in JSON (properties: serviceguid, name, value)
+#security: Returns all part values, without checking the current user security profile
+  ServiceCatalogInterface.getPublishedServiceParts(guid, ["part1", "part2"])
+  ''return'': template fields for the given service guid
-== FormsInterface (7.22.06) ==
+==== Get secure published service part values (7.21.07) ====
-The FormsInterface contains function that interact with request forms
+#first parameter: serviceguid
+#second parameter: array of internal names of the parts (pass null to get all parts)
+#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all part values and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getPublishedServicePartsSecure(guid, ["part1", "part2"])
+ ''return'': template fields for the given service guid
-WARNING: the non-secure versions of the interface behave like secure until 7.22.09
+==== Get multiple published services part values (7.21.07) ====
+#first parameter: array with serviceguids
+#second parameter: array of internal names of the parts (pass null to get all parts)
+#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all part values, without checking the current user security profile
+ ServiceCatalogInterface.getPublishedServicesParts([guid1, guid2], ["part1", "part2"])
+ ''return'': template fields for the given service guid
-=== General ===
+==== Get secure multiple published services details (7.21.07) ====
-==== List categories ====
+#first parameter: array with serviceguids
-Returns the categories
+#second parameter: array of internal names of the parts (pass null to get all parts)
-  FormsInterface.getCategories();
+#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
-  ''returns'': array of objects with properties id, islive, iconurl, title, description, helptext in JSON
+#security: Returns all part values, without checking the current user security profile
+  ServiceCatalogInterface.getPublishedServicesPartsSecure([guid1, guid2], ["part1", "part2"])
+  ''return'': template fields for the given service guid
-==== List categories SECURE (7.22.09) ====
+==== Get all published services part values (7.21.07) ====
-Returns the categories based on the logged in user
+#first parameter: array of internal names of the parts (pass null to get all parts)
-  FormsInterface.getCategoriesSecure();
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
-  ''returns'': array of objects with properties id, islive, iconurl, title, description, helptext in JSON
+#security: Returns all part values for all services, without checking the current user security profile
+  ServiceCatalogInterface.getAllPublishedServicesParts(["part1", "part2"])
+  ''return'': template fields
-==== Get category ====
+==== Get secure all published services details (7.21.07) ====
-Gets a category based on the id
+#first parameter: array of internal names of the parts (pass null to get all parts)
-#first parameter: category id
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
- FormsInterface.getCategory(1);
+#security: Returns all part values for all services and checks if the current user is authorized to retrieve these details (at least read rights)
- ''returns'': object with properties title and topics (array of objects with properties id, islive, iconurl, title, description, helptext) in JSON
+ ServiceCatalogInterface.getAllPublishedServicesPartsSecure(["part1", "part2"])
+ ''return'': template fields
-==== Get category SECURE (7.22.09) ====
+==== Search published services using text search (with Lucene) (7.21.11) ====
-Gets a category based on the id, only if the logged in user has rights for this
+#first parameter: language id
-#first parameter: category id
+#second parameter: the text to search (allows for * and ?) (since 7.23.12: can be null, then no text filter is set, usefull when using 'serviceguid(s)' in optional third parameter)
-  FormsInterface.getCategorySecure(1);
+#optional third parameter: object with properties 'itemsperpage' (default 100), 'after' (pass the object 'lastinfo' from the previous search result), 'escapesearchtext', 'templatename', 'templatetype', 'servicetype' and since 7.23.12: serviceguid, name, summary, owner, ownerdeputy, manager, tag, provider, receiver, documentname, requestname, part, includesuggestions
-  ''returns'': object with properties islive, title and topics (array of objects with properties id, islive, iconurl, title, description, helptext) in JSON
+#security: this function returns all published services, without checking the current user security profile
+  ServiceCatalogInterface.textSearch(1, "how to ride a bike", { templatetype: "Knowledge_article" });
+  ''return'':  An object with properties 'totalhits' (total amount of hits), 'entries' (array of search result entries containing possibly the following data: guid, name, summary, servicetype, templatename, templatetype and since 7.23.12: dataobject, owner, ownerdeputy, manager, tags, provider, receivers, documentnames, documents, requestnames, requests, parts), 'lastinfo' (contains the needed info to fetch the next batch of results) and since 7.23.12: 'suggestions' (array of objects with properties: text, totalhits)
-==== Get topic ====
+==== Search published services using multiple texts search (with Lucene) (7.23.12) ====
-Gets a topic based on the id
+#first parameter: language id
-#first parameter: topic id
+#second parameter: the array of text to search (allows for * and ?) (can be null, then no text filter is set, usefull when using 'serviceguid(s)' in optional third parameter)
-  FormsInterface.getTopic(1);
+#optional third parameter: object with properties 'itemsperpage' (default 100), 'after' (pass the object 'lastinfo' from the previous search result), 'escapesearchtext', 'templatename', 'templatetype', 'servicetype', serviceguid, name, summary, owner, ownerdeputy, manager, tag, provider, receiver, documentname, requestname, part, includesuggestions
-  ''returns'': object with properties categoryid, categorytitle, categoryislive, title, islive and forms (array of objects with properties id, islive, onlyindirectlyaccessible, contenttypeid, iconurl, title, description) in JSON
+#security: this function returns all published services, without checking the current user security profile
+  ServiceCatalogInterface.textsSearch(1, ["how to ride a bike", "how to drive a car"], { templatetype: "Knowledge_article" });
+  ''return'':  An array of the same size as the second input parameter of objects with properties 'totalhits' (total amount of hits), 'entries' (array of search result entries containing possibly the following data: guid, name, summary, servicetype, templatename, templatetype and since 7.23.12: dataobject, owner, ownerdeputy, manager, tags, provider, receivers, documentnames, documents, requestnames, requests, parts), 'lastinfo' (contains the needed info to fetch the next batch of results), 'suggestions' (array of objects with properties: text, totalhits)
-==== Get topic SECURE (7.22.09) ====
+==== Search secure published services using text search (with Lucene) (7.21.11) ====
-Gets a topic based on the id, only if the logged in user has rights for this
+#first parameter: language id
-#first parameter: topic id
+#second parameter: the text to search (allows for * and ?) (since 7.23.12: can be null, then no text filter is set, usefull when using 'serviceguid(s)' in optional third parameter)
-  FormsInterface.getTopic(1);
+#optional third parameter: object with properties 'itemsperpage' (default 100), 'after' (pass the object 'lastinfo' from the previous search result), 'escapesearchtext', 'templatename', 'templatetype', 'servicetype' and since 7.23.12: serviceguid, name, summary, owner, ownerdeputy, manager, tag, provider, receiver, documentname, requestname, part, includesuggestions
-  ''returns'': object with properties categoryid, categorytitle, categoryislive, title, islive and forms (array of objects with properties id, islive, onlyindirectlyaccessible, contenttypeid, iconurl, title, description) in JSON
+#security: this function returns all published services and checks the current user security profile
+  ServiceCatalogInterface.textSearchSecure(1, "how to ride a bike", { templatetype: "Knowledge_article" });
+  ''return'':  An object with properties 'totalhits' (total amount of hits), 'entries' (array of search result entries containing possibly the following data: guid, name, summary, servicetype, templatename, templatetype and since 7.23.12: dataobject, owner, ownerdeputy, manager, tags, provider, receivers, documentnames, documents, requestnames, requests, parts), 'lastinfo' (contains the needed info to fetch the next batch of results) and since 7.23.12: 'suggestions' (array of objects with properties: text, totalhits)
-==== Get form ====
+==== Search secure published services using multiple texts search (with Lucene) (7.23.12) ====
-Gets a form based on the id
+#first parameter: language id
-#first parameter: form id
+#second parameter: the array of texts to search (allows for * and ?) (can be null, then no text filter is set, usefull when using 'serviceguid(s)' in optional third parameter)
-  FormsInterface.getForm(1);
+#optional third parameter: object with properties 'itemsperpage' (default 100), 'after' (pass the object 'lastinfo' from the previous search result), 'escapesearchtext', 'templatename', 'templatetype', 'servicetype' and since 7.23.12: serviceguid, name, summary, owner, ownerdeputy, manager, tag, provider, receiver, documentname, requestname, part, includesuggestions
-  ''returns'': object with properties categoryid, categorytitle, categoryislive, topicid, topictitle, topicislive, id, islive, title, description, showaddtofavorites (7.22.07), showsaveasdraft(7.22.07), showsaveastemplate(7.22.07), onlyindirectlyaccessible (7.22.10), hasadmin and isfavorite in JSON
+#security: this function returns all published services and checks the current user security profile
+  ServiceCatalogInterface.textsSearchSecure(1, ["how to ride a bike", "how to drive a car"], { templatetype: "Knowledge_article" });
+  ''return'':  An array of the same size as the second input parameter with objects with properties 'totalhits' (total amount of hits), 'entries' (array of search result entries containing possibly the following data: guid, name, summary, servicetype, templatename, templatetype and since 7.23.12: dataobject, owner, ownerdeputy, manager, tags, provider, receivers, documentnames, documents, requestnames, requests, parts), 'lastinfo' (contains the needed info to fetch the next batch of results), 'suggestions' (array of objects with properties: text, totalhits)
-==== Get form SECURE (7.22.09) ====
+==== Search for word suggestions based on published services (with Lucene) (7.23.12) ====
-Gets a form based on the id, only if the logged in user has rights for this
+#first parameter: language id
-#first parameter: form id
+#second parameter: the word the search suggestions for
- FormsInterface.getForm(1);
+#optional third parameter: object with properties 'nrofresults' (default 5)
- ''returns'': object with properties categoryid, categorytitle, categoryislive, topicid, topictitle, topicislive, id, islive, title, description, showaddtofavorites (7.22.07), showsaveasdraft(7.22.07), showsaveastemplate(7.22.07), onlyindirectlyaccessible (7.22.10), hasadmin and isfavorite in JSON
-==== Get favorite forms SECURE (7.22.09) ====
+  ServiceCatalogInterface.textSearchSuggestSimilar(1, "artilce");
-Gets the list of favorite forms
+  ''return'':  A json encoded array of suggestions (string)
-  FormsInterface.getFavoriteFormsSecure();
-  ''returns'': array of objects with properties categoryid, categorytitle, categoryislive, topicid, topictitle, topicislive, id, islive, title, description, showaddtofavorites (7.22.07), showsaveasdraft(7.22.07), showsaveastemplate(7.22.07), onlyindirectlyaccessible (7.22.10), hasadmin and isfavorite in JSON
-==== Remove favorite form SECURE (7.22.09) ====
+==== Search for multiple word suggestions bsaed on published services (with Lucene) (7.23.12) ====
-Removes a form from the persons favorites
+#first parameter: language id
-#first parameter: id of the form
+#second parameter: the array of words to search suggestions for
-  FormsInterface.removeFavoriteFormSecure(1);
+#optional third parameter: object with properties 'nrofresults' (default 5)
-  ''returns'': nothing
+  ServiceCatalogInterface.textsSearchSuggestSimilar(1, ["artilce", "atricle"]);
+  ''return'':  An array of the same size as the second input parameter of arrays with suggestions (string)
-==== Add favorite form SECURE (7.22.09) ====
+=== Service versions ===
-Adds a form to the persons favorites
-#first parameter: id of the form
- FormsInterface.addFavoriteFormSecure(1);
- ''returns'': nothing
-==== Get form instances SECURE (7.22.09) ====
+==== Get service version overview (7.24.02) ====
-Gets the list of form instances for the logged in user based on type/status (Draft or Template)
+#first parameter: serviceguid
-#first parameter: the string "Draft" or "Template"
+#second parameter: versionnumber
-  FormsInterface.getFormInstancesSecure("Draft");
+#optional third parameter: object with LanguageId
-  ''returns'': array of objects with properties id, extraparameters, formid, formtitle, instancetitle, dateaddedticks, dateadded in JSON
+#security: Returns a overview of the service, without checking the current user security profile
+  ServiceCatalogInterface.getServiceVersionOverview(guid, versionnumber)
-==== Remove form instance SECURE (7.22.09) ====
+  ''return'': the same fields as the list method returns
-Removes a form instance only if the logged in user owns the form instance
-#first parameter: the string "Draft" or "Template"
+==== Get secure service version overview (7.24.02) ====
-#second parameter: id of the form instance
+#first parameter: serviceguid
-  FormsInterface.removeFormInstanceSecure("Draft", 1);
+#second parameter: versionnumber
-  ''returns'': nothing
+#optional third parameter: object with LanguageId
+#security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+  ServiceCatalogInterface.getServiceVersionOverviewSecure(guid, versionnumber)
+  ''return'': the same fields as the list method returns
-==== Search forms and shops SECURE (7.22.09) ====
+==== Get service version summary (7.21.12) ====
-Returns the forms and shops based on the text
+#first parameter: serviceguid
-#first parameter: text to search for
+#second parameter: versionnumber
-#optional second parameter: max records to return (default = 10)
+#optional third parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
-  FormsInterface.searchFormsAndShopsSecure("phone");
+#security: Returns a summary of the service, without checking the current user security profile
-  ''returns'': array of object with properties id, typename, title, topictitle, categorytitle, iconurl in JSON
+ ServiceCatalogInterface.getServiceVersionSummary(guid, versionnumber)
+ ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+==== Get secure service version summary (7.21.12) ====
+#first parameter: serviceguid
+#second parameter: versionnumber
+#optional third parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceVersionSummarySecure(guid, versionnumber)
+ ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+==== Get service version details (7.21.12) ====
+#first parameter: serviceguid
+#second parameter: versionnumber
+#optional third parameter: object with properties:
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+ - LanguageId (id of the language to use) (7.22.03)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+  - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details, without checking the current user security profile
+ ServiceCatalogInterface.getServiceVersionDetail(guid, versionnumber)
+  ''return'': all fields, including template fields for the given service guid and versionnumber
+==== Get secure service version details (7.21.12) ====
+#first parameter: serviceguid
+#second parameter: versionnumber
+#optional third parameter: object with properties:
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+ - LanguageId (id of the language to use) (7.22.03)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceVersionDetailSecure(guid, versionnumber)
+ ''return'': all fields, including template fields for the given service guid and versionnumber
+=== Services ===
-==== Remove form instance (7.22.09) ====
+==== Get secure count of all records (7.21.12) ====
-Removes a form instance
+#no parameters
-#first parameter: id of the form instance
+#security: this function returns the count of all records (services and knowledge articles) and checks the current user security profile
+ ServiceCatalogInterface.getCountRecordsSecure();
+ ''return'': number
+==== Get secure list of all records (7.21.12) ====
+#optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all records (services and knowledge articles) and checks the current user security profile for all returning authorized records
+ ServiceCatalogInterface.getAllRecordsSecure();
+ ''return'':  An array of all currently records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Get count of all records (7.21.12) ====
+#no parameters
+#security: this function returns the count of all records (services and knowledge articles), without checking the current user security profile
+ ServiceCatalogInterface.getCountRecords();
+ ''return'': number
+==== Get list of all records (7.21.12) ====
+#optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all records (services and knowledge articles), without checking the current user security profile
+ ServiceCatalogInterface.getAllRecords();
+ ''return'':  An array of all currently records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Get secure count of all services (7.21.12) ====
+#no parameters
+#security: this function returns the count of all services and checks the current user security profile
+ ServiceCatalogInterface.getCountServicesSecure();
+ ''return'': number
+==== Get secure list of all services (7.21.12) ====
+#optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all services and checks the current user security profile
+ ServiceCatalogInterface.getAllServicesSecure();
+ ''return'':  An array of all currently services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Get count of all services (7.21.12) ====
+#no parameters
+#security: this function returns the count all services, without checking the current user security profile
+ ServiceCatalogInterface.getCountServices();
+ ''return'': number
+==== Get list of all services (7.21.12) ====
+#optional first parameter: object with LanguageId (7.22.08)
+#security: this function returns all services, without checking the current user security profile
+ ServiceCatalogInterface.getAllServices();
+ ''return'':  An array of all currently services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Get secure count of all knowledge articles (7.21.12) ====
+#no parameters
+#security: this function returns the count of all knowledge articles and checks the current user security profile
+ ServiceCatalogInterface.getCountKnowledgeArticlesSecure();
+ ''return'': number
+==== Get secure list of all knowledge articles (7.21.12) ====
+#optional first parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all knowledge articles and checks the current user security profile
+ ServiceCatalogInterface.getAllKnowledgeArticlesSecure();
+ ''return'':  An array of all currently knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Get count of all knowledge articles (7.21.12) ====
+#no parameters
+#security: this function returns the count all knowledge articles, without checking the current user security profile
+ ServiceCatalogInterface.getCountKnowledgeArticles();
+ ''return'': number
+==== Get list of all knowledge articles (7.21.12) ====
+#optional first parameter: object with LanguageId (7.22.08)
+#security: this function returns all knowledge articles, without checking the current user security profile
+ ServiceCatalogInterface.getAllKnowledgeArticles();
+ ''return'':  An array of all currently knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Get secure count of all records (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#security: this function returns the count of all records based on the search criteria (services and knowledge articles) and checks the current user security profile
+ ServiceCatalogInterface.searchCountRecordsSecure(searchcriteria);
+ ''return'': number
+==== Get secure list of all records (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all records based on the search criteria (services and knowledge articles) and checks the current user security profile for all returning authorized records
+ ServiceCatalogInterface.searchAllRecordsSecure(searchcriteria);
+ ''return'':  An array of all currently records for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Get count of all records (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#security: this function returns the count of all records based on the search criteria (services and knowledge articles), without checking the current user security profile
+ ServiceCatalogInterface.searchCountRecords(searchcriteria);
+ ''return'': number
+==== Get list of all records (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all records based on the search criteria (services and knowledge articles), without checking the current user security profile
+ ServiceCatalogInterface.searchAllRecords(searchcriteria);
+ ''return'':  An array of all currently records, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Search secure count of all services (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#security: this function returns the count of all services based on the search criteria and checks the current user security profile
+ ServiceCatalogInterface.searchCountServicesSecure(searchcriteria);
+ ''return'': number
+==== Search secure list of all services (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all services based on the search criteria and checks the current user security profile
+ ServiceCatalogInterface.searchAllServicesSecure(searchcriteria);
+ ''return'':  An array of all currently services for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Search count of all services (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#security: this function returns the count all services based on the search criteria, without checking the current user security profile
+ ServiceCatalogInterface.searchCountServices(searchcriteria);
+ ''return'': number
+==== Search list of all services (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all services based on the search criteria, without checking the current user security profile
+ ServiceCatalogInterface.searchAllServices(searchcriteria);
+ ''return'':  An array of all currently services, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+ ''example criteria'': { templatename: ["Template 1", "Template 2"] }
+ '' available criteria: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06)
+==== Search secure count of all knowledge articles (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#security: this function returns the count of all knowledge articles based on the search criteria and checks the current user security profile
+ ServiceCatalogInterface.searchCountKnowledgeArticlesSecure(searchcriteria);
+ ''return'': number
+==== Search secure list of all knowledge articles (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all knowledge articles based on the search criteria and checks the current user security profile
+ ServiceCatalogInterface.searchAllKnowledgeArticlesSecure(searchcriteria);
+ ''return'':  An array of all currently knowledge articles for which the current user is authorized, containing the following data: serviceid, serviceguid, versionnumber, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Search count of all knowledge articles (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#security: this function returns the count all knowledge articles based on the search criteria, without checking the current user security profile
+ ServiceCatalogInterface.searchCountKnowledgeArticles(searchcriteria);
+ ''return'': number
+==== Search list of all knowledge articles (7.22.04) ====
+#first parameter: object with search criteria (possible keys: hasexpiredreviewcycle, reviewcyclevalidityenddateuntil, servicetypes, templatenames, templatetypes, ispublished(7.24.06))
+#optional second parameter: object with properties itemsperpage and pageindex or languageid (7.22.08)
+#security: this function returns all knowledge articles based on the search criteria, without checking the current user security profile
+ ServiceCatalogInterface.searchAllKnowledgeArticles(searchcriteria);
+ ''return'':  An array of all currently knowledge articles, containing the following data: serviceid, serviceguid, versionnumber, template guid, template name, template hide in public, template typeid, phase id, phase name, phase typeid (since 7.24.03), phase typename (since 7.24.03), servicetypeid, servicetypename, name of service, description, summary, providers, receivers, owner, ownerdeputy, servicemanager.
+==== Get service overview (7.24.02) ====
+#first parameter: serviceguid
+#optional second parameter: object with LanguageId
+#security: Returns a overview of the service, without checking the current user security profile
+ ServiceCatalogInterface.getServiceOverview(guid)
+ ''return'': the same fields as the list method returns
+==== Get secure service overview (7.24.02) ====
+#first parameter: serviceguid
+#optional second parameter: object with LanguageId
+#security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceOverviewSecure(guid)
+ ''return'': the same fields as the list method returns
+==== Get multiple services overview (7.24.02) ====
+#first parameter: array with serviceguids
+#security: Returns a overview of the service, without checking the current user security profile
+ ServiceCatalogInterface.getServicesOverview([guid1, guid2])
+ ''return'': an array with services containing the same fields as the list method returns
+==== Get all services overview (7.24.02) ====
+#optional first parameter: object with LanguageId
+#security: Returns a overview of the service, without checking the current user security profile
+ ServiceCatalogInterface.getAllServicesOverview()
+ ''return'': an array with services containing the same fields as the list method returns
+==== Get secure multiple services overview (7.24.02) ====
+#first parameter: array with serviceguids
+#optional second parameter: object with LanguageId
+#security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServicesOverviewSecure([guid1, guid2])
+ ''return'': an array with services containing the same fields as the list method returns
+==== Get secure all services overview (7.24.02) ====
+#optional first parameter: object with LanguageId
+#security: Returns a overview of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getAllServicesOverviewSecure()
+ ''return'': an array with services containing the same fields as the list method returns
+==== Get service summary (7.21.12) ====
+#first parameter: serviceguid
+#optional second parameter: object with properties LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns a summary of the service, without checking the current user security profile
+ ServiceCatalogInterface.getServiceSummary(guid)
+ ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+==== Get secure service summary (7.21.12) ====
+#first parameter: serviceguid
+#optional second parameter: object with properties LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceSummarySecure(guid)
+ ''return'': the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+==== Get multiple services summary (7.21.12) ====
+#first parameter: array with serviceguids
+#security: Returns a summary of the service, without checking the current user security profile
+ ServiceCatalogInterface.getServicesSummary([guid1, guid2])
+ ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+==== Get all services summary (7.21.12) ====
+#optional first parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns a summary of the service, without checking the current user security profile
+ ServiceCatalogInterface.getAllServicesSummary()
+ ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+==== Get secure multiple services summary (7.21.12) ====
+#first parameter: array with serviceguids
+#optional second parameter: object with properties LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServicesSummarySecure([guid1, guid2])
+ ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+==== Get secure all services summary (7.21.12) ====
+#optional first parameter: object with LanguageId (7.22.08) - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns a summary of the service and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getAllServicesSummarySecure()
+ ''return'': an array with services containing the same fields as the list method returns + icon, banner, list of parent service guids, list of child service guids and list of knowledge article guids, editorpersons, editorpersongroups, technicalapprovalpersons, technicalapprovalpersongroups, customerapprovalpersons and customactors
+==== Get service details (7.21.12) ====
+#first parameter: serviceguid
+#optional second parameter: object with properties:
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+ - LanguageId (id of the language to use) (7.22.03)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details, without checking the current user security profile
+ ServiceCatalogInterface.getServiceDetail(guid)
+ ''return'': all fields, including template fields for the given service guid
+ Please note that there is an optional parameter to retrieve the service details in a specific languange. Use this: ServiceCatalogInterface.getServiceDetail(guid, { LanguageId: 1 }) to get the service details in the language English. (1=English, 2=Dutch, 3=French, 4=German).
+==== Get secure service details (7.21.12) ====
+#first parameter: serviceguid
+#optional second parameter: object with properties:
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+ - LanguageId (id of the language to use) (7.22.03)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceDetailSecure(guid)
+ ''return'': all fields, including template fields for the given service guid
+==== Get multiple services details (7.21.12) ====
+#first parameter: array with serviceguids
+#optional second parameter: object with properties:
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+ - LanguageId (id of the language to use) (7.22.03)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details, without checking the current user security profile
+ ServiceCatalogInterface.getServicesDetail([guid1, guid2])
+ ''return'': an array with services containing all fields, including template fields for the given service guids
+==== Get all services details (7.21.12) ====
+#optional second parameter: object with properties:
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+ - LanguageId (id of the language to use) (7.22.03)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details, without checking the current user security profile
+ ServiceCatalogInterface.getAllServicesDetail()
+ ''return'': an array with services containing all fields, including template fields
+==== Get secure multiple services details (7.21.12) ====
+#first parameter: array with serviceguids
+#optional second parameter: object with properties:
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+ - LanguageId (id of the language to use) (7.22.03)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServicesDetailSecure([guid1, guid2])
+ ''return'': an array with services containing all fields, including template fields for the given service guids
+==== Get secure all services details (7.21.12) ====
+#optional second parameter: object with properties:
+ - SelectionFieldsUseKeys (true = return keys instead of display value) (7.21.07)
+ - LanguageId (id of the language to use) (7.22.03)
+ - PartsAsFlatList (true = return array of parts instead of array of tabs with array of parts) (7.22.04)
+ - BBCodeFieldsUseValue (true = return bb code instead of html) (7.22.10)
+ - PartsUseValue (default value for SelectionFieldsUseKeys and BBCodeFieldsUseValue) (7.22.10)
+ - since 7.23.05: LoadRelations, LoadParents, LoadChildren
+#security: Returns all service details and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getAllServicesDetailSecure()
+ ''return'': an array with services containing all fields, including template fields
+=== Service parts ===
+==== Get service part values (7.22.02) ====
+#first parameter: serviceguid
+#second parameter: array of internal names of the parts (pass null to get all parts)
+#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all part values, without checking the current user security profile
+ ServiceCatalogInterface.getServiceParts(guid, ["part1", "part2"])
+ ''return'': template fields for the given service guid
+==== Get secure service part values (7.22.02) ====
+#first parameter: serviceguid
+#second parameter: array of internal names of the parts (pass null to get all parts)
+#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all part values and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServicePartsSecure(guid, ["part1", "part2"])
+ ''return'': template fields for the given service guid
+==== Get multiple services part values (7.22.02) ====
+#first parameter: array with serviceguids
+#second parameter: array of internal names of the parts (pass null to get all parts)
+#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all part values, without checking the current user security profile
+ ServiceCatalogInterface.getServicesParts([guid1, guid2], ["part1", "part2"])
+ ''return'': template fields for the given service guid
+==== Get secure multiple services part values (7.22.02) ====
+#first parameter: array with serviceguids
+#second parameter: array of internal names of the parts (pass null to get all parts)
+#optional third parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all part values and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServicesPartsSecure([guid1, guid2], ["part1", "part2"])
+ ''return'': template fields for the given service guid
+==== Get all services part values (7.22.02) ====
+#first parameter: array of internal names of the parts (pass null to get all parts)
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all part values for all services, without checking the current user security profile
+ ServiceCatalogInterface.getAllServicesParts(["part1", "part2"])
+ ''return'': template fields
+==== Get secure all services part values (7.22.02) ====
+#first parameter: array of internal names of the parts (pass null to get all parts)
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all part values for all services and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getAllServicesPartsSecure(["part1", "part2"])
+ ''return'': template fields
+=== Service relations (7.24.02) ===
+==== Get service relation ====
+#first parameter: parent serviceguid
+#second parameter: child serviceguid
+#optional third parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns the relation, without checking the current user security profile
+ ServiceCatalogInterface.getServiceRelation(parentserviceguid, childserviceguid)
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get secure service relation ====
+#first parameter: parent serviceguid
+#second parameter: child serviceguid
+#optional third parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns the relation and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceRelationSecure(parentserviceguid, childserviceguid)
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get service relations as parent ====
+#first parameter: parent serviceguid
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the parent, without checking the current user security profile
+ ServiceCatalogInterface.getServiceRelationsAsParent(parentserviceguid)
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get secure service relations as parent ====
+#first parameter: parent serviceguid
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the parent and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceRelationsAsParentSecure(parentserviceguid)
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get multiple service relations as parent ====
+#first parameter: array of parent serviceguids
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the parent, without checking the current user security profile
+ ServiceCatalogInterface.getServicesRelationsAsParent([parentserviceguid1, parentserviceguid2])
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get multiple secure service relations as parent ====
+#first parameter: array of parent serviceguids
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the parent and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServicesRelationsAsParentSecure([parentserviceguid1, parentserviceguid2])
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get service relations as child ====
+#first parameter: child serviceguid
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the child, without checking the current user security profile
+ ServiceCatalogInterface.getServiceRelationsAsChild(childserviceguid)
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get secure service relations as child ====
+#first parameter: child serviceguid
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the child and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceRelationsAsChildSecure(childserviceguid)
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get multiple service relations as child ====
+#first parameter: array of child serviceguids
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the child, without checking the current user security profile
+ ServiceCatalogInterface.getServicesRelationsAsChild([childserviceguid1, childserviceguid2])
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get multiple secure service relations as child ====
+#first parameter: array of child serviceguids
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the child and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServicesRelationsAsChildSecure([childserviceguid1, childserviceguid2])
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get service relations ====
+#first parameter: serviceguid
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the parent or child, without checking the current user security profile
+ ServiceCatalogInterface.getServiceRelations(serviceguid)
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get secure service relations ====
+#first parameter: serviceguid
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the parent or child and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceRelationsSecure(serviceguid)
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get multiple service relations ====
+#first parameter: array of serviceguids
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the child or the parent, without checking the current user security profile
+ ServiceCatalogInterface.getServicesRelations([serviceguid1, serviceguid2])
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get multiple secure service relations ====
+#first parameter: array of serviceguids
+#optional second parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations where the service guid is the child or the parent and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServicesRelationsSecure([serviceguid1, serviceguid2])
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get all service relations ====
+#optional first parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations, without checking the current user security profile
+ ServiceCatalogInterface.getAllServicesRelations()
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+==== Get all secure service relations ====
+#optional first parameter: object with properties languageid, selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (true = return bb code instead of html), partsusevalue (default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all relations and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getAllServicesRelationsSecure()
+ ''return'': the relation as an object (properties: parentserviceid, parentserviceguid, childserviceid, childserviceguid, parts (array of objects))
+=== Review cycles ===
+==== Get service review cycles (7.22.04) ====
+#first parameter: serviceguid
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all review cycles, without checking the current user security profile
+ ServiceCatalogInterface.getServiceReviewCycles(guid)
+ ''return'': all review cycles for the given service guid
+==== Get secure service review cycles (7.22.04) ====
+#first parameter: serviceguid
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all review cycles and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceReviewCyclesSecure(guid)
+ ''return'': all review cycles for the given service guid
+==== Get multiple services review cycles (7.22.04) ====
+#first parameter: array with serviceguids
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all review cycles, without checking the current user security profile
+ ServiceCatalogInterface.getServicesReviewCycles([guid1, guid2])
+ ''return'': all review cycles for the given service guids
+==== Get secure multiple services review cycles (7.22.04) ====
+#first parameter: array with serviceguids
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all review cycles and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServicesReviewCyclesSecure([guid1, guid2])
+ ''return'': all review cycles for the given service guids
+==== Get all services review cycles (7.22.04) ====
+#optional first parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all review cycles for all services, without checking the current user security profile
+ ServiceCatalogInterface.getAllServicesReviewCycles()
+ ''return'': all review cycles
+==== Get secure all services review cycles (7.22.04) ====
+#optional first parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all review cycles for all services and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getAllServicesReviewCyclesSecure()
+ ''return'': all review cycles
+==== Get review cycle (7.22.04) ====
+#first parameter: reviewcycleguid
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns the review cycle, without checking the current user security profile
+ ServiceCatalogInterface.getReviewCycle(reviewcycleguid)
+ ''return'': the review cycle
+==== Get secure review cycles (7.22.04) ====
+#first parameter: reviewcycleguid
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns the review cycle and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getReviewCycleSecure(reviewcycleguid)
+ ''return'': the review cycle
+==== Get multiple review cycles (7.22.04) ====
+#first parameter: array with reviewcycleguids
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all review cycles, without checking the current user security profile
+ ServiceCatalogInterface.getReviewCycles([guid1, guid2])
+ ''return'': the review cycles
+==== Get secure multiple review cycles (7.22.04) ====
+#first parameter: array with reviewcycleguids
+#optional second parameter: object with property selectionfieldsusekeys (true = return keys instead of display value), bbcodefieldsusevalue (7.22.10, true = return bb code instead of html), usevalue (7.22.10, default value for selectionfieldsusekeys and bbcodefieldsusevalue)
+#security: Returns all review cycles and checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getReviewCyclesSecure([guid1, guid2])
+ ''return'': the review cycles
+=== Service variables ===
+==== Get service variable value secure (7.22.07) ====
+#first parameter: service guid
+#second parameter: variable name
+#security: Checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceVariableValueSecure(guid, variablename)
+ ''return'': the value (string)
+==== Get service variable value (7.22.07) ====
+#first parameter: service guid
+#second parameter: variable name
+#security: No checks are done
+ ServiceCatalogInterface.getServiceVariableValue(guid, variablename)
+ ''return'': the value (string)
+==== Set service variable value secure (7.22.07) ====
+#first parameter: service guid
+#second parameter: variable name
+#third parameter: variable value
+#security: Checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.setServiceVariableValueSecure(guid, variablename, variablevalue)
+ ''return'': nothing
+==== Set service variable value (7.22.07) ====
+#first parameter: service guid
+#second parameter: variable name
+#third parameter: variable value
+#security: No checks are done
+ ServiceCatalogInterface.setServiceVariableValue(guid, variablename, variablevalue)
+ ''return'': nothing
+==== Get service variables secure (7.22.07) ====
+#first parameter: service guid
+#security: Checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServiceVariablesSecure(guid)
+ ''return'': array of variables in JSON (properties: serviceguid, name, value)
+==== Get service variables (7.22.07) ====
+#first parameter: service guid
+#security: No checks are done
+ ServiceCatalogInterface.getServiceVariables(guid)
+ ''return'': array of variables in JSON (properties: serviceguid, name, value)
+==== Get services variables secure (7.22.07) ====
+#first parameter: array of service guids
+#security: Checks if the current user is authorized to retrieve these details (at least read rights)
+ ServiceCatalogInterface.getServicesVariablesSecure([guid1, guid2])
+ ''return'': array of variables in JSON (properties: serviceguid, name, value)
+==== Get services variables (7.22.07) ====
+#first parameter: array of service guids
+#security: No checks are done
+ ServiceCatalogInterface.getServicesVariables([guid1, guid2])
+ ''return'': array of variables in JSON (properties: serviceguid, name, value)
+==== Get services variables (7.22.07) ====
+#first parameter: array of service guids
+#security: No checks are done
+ ServiceCatalogInterface.getServicesVariables([guid1, guid2])
+ ''return'': array of variables in JSON (properties: serviceguid, name, value)
+=== Rights ===
+==== Check if the logged in person has service admin rights (7.23.03) ====
+#first parameter: service guid
+ ServiceCatalogInterface.loggedInPersonHasServiceAdminRights(guid)
+ ''return'': true if the person has at least view rights in the admin panel for this service, false otherwise
+==== Check if the logged in person has service admin edit rights (7.23.03) ====
+Since 7.23.11: warning - will be removed in a future version
+#first parameter: service guid
+ ServiceCatalogInterface.loggedInPersonHasServiceAdminEditRights(guid)
+ ''return'': true if the person has edit rights in the admin panel for this service, false otherwise
+ ''return since 7.23.11'': always false, please use custom ACLs instead
+==== Check if the logged in person has a service custom ACL use right (7.23.11) ====
+#first parameter: service guid
+#second parameter: name of the custom ACL
+ ServiceCatalogInterface.loggedInPersonHasServiceCustomAclUseRight(guid, name)
+ ''return'': true if the person has the use right for the ACL in this service, false otherwise
+==== Check if the logged in person has a service version custom ACL use right (7.24.10) ====
+#first parameter: service guid
+#second parameter: version number
+#thirdparameter: name of the custom ACL
+ ServiceCatalogInterface.loggedInPersonHasServiceVersionCustomAclUseRight(serviceguid, versionnr, name)
+ ''return'': true if the person has the use right for the ACL in this service, false otherwise
+== FormsInterface (7.22.06) ==
+The FormsInterface contains function that interact with request forms
+WARNING: the non-secure versions of the interface behave like secure until 7.22.09
+=== General ===
+==== List categories ====
+Returns the categories
+ FormsInterface.getCategories();
+ ''returns'': array of objects with properties id, islive, iconurl, title, description, helptext in JSON
+==== List categories SECURE (7.22.09) ====
+Returns the categories based on the logged in user
+ FormsInterface.getCategoriesSecure();
+ ''returns'': array of objects with properties id, islive, iconurl, title, description, helptext in JSON
+==== Get category ====
+Gets a category based on the id
+#first parameter: category id
+ FormsInterface.getCategory(1);
+ ''returns'': object with properties title and topics (array of objects with properties id, islive, iconurl, title, description, helptext) in JSON
+==== Get category SECURE (7.22.09) ====
+Gets a category based on the id, only if the logged in user has rights for this
+#first parameter: category id
+ FormsInterface.getCategorySecure(1);
+ ''returns'': object with properties islive, title and topics (array of objects with properties id, islive, iconurl, title, description, helptext) in JSON
+==== Get topic ====
+Gets a topic based on the id
+#first parameter: topic id
+ FormsInterface.getTopic(1);
+ ''returns'': object with properties categoryid, categorytitle, categoryislive, title, islive and forms (array of objects with properties id, islive, onlyindirectlyaccessible, contenttypeid, iconurl, title, description), subnavcssclass (since 7.23.10) in JSON
+==== Get topic SECURE (7.22.09) ====
+Gets a topic based on the id, only if the logged in user has rights for this
+#first parameter: topic id
+ FormsInterface.getTopicSecure(1);
+ ''returns'': object with properties categoryid, categorytitle, categoryislive, title, islive and forms (array of objects with properties id, islive, onlyindirectlyaccessible, contenttypeid, iconurl, title, description), subnavcssclass (since 7.23.10) in JSON
+==== Get all topics (7.24.07) ====
+Gets all topics
+ FormsInterface.getAllTopics();
+ ''returns'': array of objects with properties id, islive, title, iconurl, description, helptext, subnavcssclass, categoryid in JSON
+==== Get all topics SECURE (7.24.07) ====
+Gets all topics where the logged in user has rights for
+ FormsInterface.getAllTopicsSecure();
+ ''returns'': array of objects with properties id, islive, title, iconurl, description, helptext, subnavcssclass, categoryid in JSON
+==== Get form ====
+Gets a form based on the id
+#first parameter: form id
+ FormsInterface.getForm(1);
+ ''returns'': object with properties categoryid, categorytitle, categoryislive, topicid, topictitle, topicislive, id, islive, title, description, showaddtofavorites (7.22.07), showsaveasdraft(7.22.07), showsaveastemplate(7.22.07), onlyindirectlyaccessible (7.22.10), hasadmin, isfavorite and iconurl (7.24.07) and showselectotheruser (7.24.12) in JSON
+==== Get form SECURE (7.22.09) ====
+Gets a form based on the id, only if the logged in user has rights for this
+#first parameter: form id
+ FormsInterface.getFormSecure(1);
+ ''returns'': object with properties categoryid, categorytitle, categoryislive, topicid, topictitle, topicislive, id, islive, title, description, showaddtofavorites (7.22.07), showsaveasdraft(7.22.07), showsaveastemplate(7.22.07), onlyindirectlyaccessible (7.22.10), hasadmin, isfavorite and iconurl (7.24.07) and showselectotheruser (7.24.12) in JSON
+==== Get favorite forms SECURE (7.22.09) ====
+Gets the list of favorite forms
+ FormsInterface.getFavoriteFormsSecure();
+ ''returns'': array of objects with properties categoryid, categorytitle, categoryislive, topicid, topictitle, topicislive, id, islive, title, description, showaddtofavorites (7.22.07), showsaveasdraft(7.22.07), showsaveastemplate(7.22.07), onlyindirectlyaccessible (7.22.10), hasadmin, isfavorite and iconurl (7.24.07) and showselectotheruser (7.24.12) in JSON
+==== Remove favorite form SECURE (7.22.09) ====
+Removes a form from the persons favorites
+#first parameter: id of the form
+ FormsInterface.removeFavoriteFormSecure(1);
+ ''returns'': nothing
+==== Add favorite form SECURE (7.22.09) ====
+Adds a form to the persons favorites
+#first parameter: id of the form
+ FormsInterface.addFavoriteFormSecure(1);
+ ''returns'': nothing
+==== Get form instances SECURE (7.22.09) ====
+Gets the list of form instances for the logged in user based on type/status (Draft or Template)
+#first parameter: the string "Draft" or "Template"
+ FormsInterface.getFormInstancesSecure("Draft");
+ ''returns'': array of objects with properties id, extraparameters, formid, formtitle, instancetitle, dateaddedticks, dateadded in JSON
+==== Remove form instance SECURE (7.22.09) ====
+Removes a form instance only if the logged in user owns the form instance
+#first parameter: the string "Draft" or "Template"
+#second parameter: id of the form instance
+ FormsInterface.removeFormInstanceSecure("Draft", 1);
+ ''returns'': nothing
+==== Search forms and shops SECURE (7.22.09) ====
+Returns the forms and shops based on the text
+#first parameter: text to search for
+#optional second parameter: max records to return (default = 10)
+ FormsInterface.searchFormsAndShopsSecure("phone");
+ ''returns'': array of objects with properties id, typename, title, topictitle, categorytitle, iconurl in JSON
+==== Search count forms (7.23.08) ====
+Returns the number of forms that matches the criteria
+#first parameter: object with possible properties: isretired, internallabel, internallabeloperator, name, nameoperator
+#optional second parameter: object with possible property: languageid
+ FormsInterface.searchCountForms({ internallabel: "phone", internallabeloperator: "contains" });
+ ''returns'': the number
+==== Search count forms SECURE (7.23.08) ====
+Returns the number of forms that matches the criteria
+#first parameter: object with possible properties: isretired, internallabel, internallabeloperator, name, nameoperator
+#optional second parameter: object with possible property: languageid
+ FormsInterface.searchCountFormsSecure({ internallabel: "phone", internallabeloperator: "contains" });
+ ''returns'': the number
+==== Search forms (7.23.08) ====
+Returns the forms that matches the criteria
+#first parameter: object with possible properties: isretired, internallabel, internallabeloperator, name, nameoperator
+#optional second parameter: object with possible properties: languageid, itemsperpage, pageindex
+ FormsInterface.searchForms({ internallabel: "phone", internallabeloperator: "contains" });
+ ''returns'': array of objects with properties id, typename, title, topictitle, categorytitle, iconurl, internallabel in JSON
+==== Search forms SECURE (7.23.08) ====
+Returns the forms that matches the criteria
+#first parameter: object with possible properties: isretired, internallabel, internallabeloperator, name, nameoperator
+#optional second parameter: object with possible properties: languageid, itemsperpage, pageindex
+ FormsInterface.searchFormsSecure({ internallabel: "phone", internallabeloperator: "contains" });
+ ''returns'': array of objects with properties id, typename, title, topictitle, categorytitle, iconurl, internallabel in JSON
+==== Remove form instance (7.22.09) ====
+Removes a form instance
+#first parameter: id of the form instance
   FormsInterface.removeFormInstance(1);
   ''returns'': nothing
 ==== Add form instance (7.22.09) ====
 Adds a form instance
 #first parameter: form (can be the id of the form, or the internal label of the form)
 #second parameter: requestor person (can be the id of the person, or the unique id or email of the person)
 #third parameter: requested for person (can be the id of the person, or the unique id or email of the person)
 #fourth parameter: title of the instance
 #fifth parameter: array of initial form values (array of objects with possible properties displayvalue, value, internallabel, form, field, fieldid, repeatablesectionfieldid, repeatablesectionindex, label, labels (object with possible properties label, languageid, language))
 #optional sixth parameter: status (Draft or Template)
   FormsInterface.addFormInstance("first form", "john@doe.com", "lisa@doe.com", "new draft", [ { internallabel: "first field",  value: "test" } ]);
   ''returns'': the id of the form instance
 ==== List views (7.22.10) ====
 Returns the views
   FormsInterface.getViews();
   ''returns'': array of objects with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON
+==== List views SECURE (7.22.10) ====
+Returns the views based on the logged in user
+ FormsInterface.getViewsSecure();
+ ''returns'': array of objects with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON
+==== Get view (7.22.10) ====
+Returns the view with the id
+#first parameter: the id of the view
+ FormsInterface.getView(1);
+ ''returns'': object with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON. Update since 7.23.05: extra property: fields, array of objects with properties sourcecolumn, name, fieldtypeid, fieldtypename, showindefault, showinextended, htmlencode, iskey, width, defaultsort, dateformat, filtertypeid, filtertypename, filterparametername, filterparametervaluefield, filterparameterdisplayfield
+==== Get view SECURE (7.22.10) ====
+Returns the view with the id only if the logged in user has rights for the view
+#first parameter: the id of the view
+ FormsInterface.getViewSecure(1);
+ ''returns'': object with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON. Update since 7.23.05: extra property: fields, array of objects with properties sourcecolumn, name, fieldtypeid, fieldtypename, showindefault, showinextended, htmlencode, iskey, width, defaultsort, dateformat, filtertypeid, filtertypename, filterparametername, filterparametervaluefield, filterparameterdisplayfield
-==== List views SECURE (7.22.10) ====
+==== Get view by name (7.25.01) ====
-Returns the views based on the logged in user
+Returns the view with the name
-  FormsInterface.getViewsSecure();
+#first parameter: the name of the view
-  ''returns'': array of objects with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON
+  FormsInterface.getViewByName("name");
+  ''returns'': object with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON. Update since 7.23.05: extra property: fields, array of objects with properties sourcecolumn, name, fieldtypeid, fieldtypename, showindefault, showinextended, htmlencode, iskey, width, defaultsort, dateformat, filtertypeid, filtertypename, filterparametername, filterparametervaluefield, filterparameterdisplayfield
-==== Get view (7.22.10) ====
+==== Get view by name SECURE (7.25.01) ====
-Returns the view with the id
+Returns the view with the name only if the logged in user has rights for the view
-#first parameter: the id of the view
+#first parameter: the name of the view
-  FormsInterface.getView(1);
+  FormsInterface.getViewByNameSecure("name");
-  ''returns'': object with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON
+  ''returns'': object with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON. Update since 7.23.05: extra property: fields, array of objects with properties sourcecolumn, name, fieldtypeid, fieldtypename, showindefault, showinextended, htmlencode, iskey, width, defaultsort, dateformat, filtertypeid, filtertypename, filterparametername, filterparametervaluefield, filterparameterdisplayfield
-==== Get view SECURE (7.22.10) ====
-Returns the view with the id only if the logged in user has rights for the view
-#first parameter: the id of the view
- FormsInterface.getViewSecure(1);
- ''returns'': object with properties id, islive, iconurl, useinadvancedviewfiltering, opendetailinnewwindow, defaultopentypeid, defaultopentypename, cssclass, alwaysopeninfullscreen, hidewhencountiszero, allowhidecolumns, width, widthfullscreen, name, description, shortname in JSON
 == KnowledgeManagementInterface (7.22.11) ==