Release	Date	Author	Comments
1.0	09/2014	JMP	First release
2.0	10/2015	JRB	New Triskell TemplateNew API REST services: ·Tasks ·Timesheet
3.0	02/2016	JRB	New API REST service: ·Timephased
4.0	05/2016	JMP	VBA examples with proxy requests
4.0	05/2016	JRB	Allow timephased with comments
4.0	05/2016	LF	Add currency to dataobjects rest service
4.1	04/2017	JMP	Add advanced lifecyle operational service
6.0	06/2017	JRB	·Remove imposed start date from gantt. ·New view to extract attributes id’s tenant_vw_attributes_list.
6.1	02/2018	JRB	Simpler way to extract data (GetData from ReportService)
6.2	11/2018	JRB	Add additional comments to timephased
6.3	11/2019	RF	Create dataobjects with Auto generate name format
6.4	06/2020	RF	Add possibility to insert timesheets by user login
6.5	08/2020	RF	New data in the return of the create List Value service
6.6	09/2020	RF	New service to change List Values
6.7	10/2020	RF	New field and options in the user creation service
6.8	12/2020	RF	New timesheet fields in the user creation service
6.9	08/2021	RF	Add the creation on Gantt feature on Create Objects
6.9.1	03/2022	RF	Start/End dates on the creation of Gantt feature on Create Objects
7.0	01/2024	RF	New parameter on the Timephased Attribute Data
7.1	05/2025	RF	Default Custom Attribute value on the Dataobject Operation: Create
7.2	10/2026	RF	New optional parameter on the Timesheet create
7.3	03/2026	RF	Update document to Bruno software
7.4	03/2026	RTM	Change ‘MD5PASSWORD’ field to ‘HASHPASSWORD’. The field now only accepts passwords in the SHA256 format. MD5PASSWORD is still accepted if password is in SHA256 format.
7.5	06/2026	RTM	Add START_DATE as an available option in the Attributes, in the User Creation REST API.
8.0	09/2026	EC	Improved API Key managementSwagger pagesOAuth2 authenticationMore authentication details

2 Introduction

Several REST web services are provided allowing tenant and customers to interact with Triskell virtually from any environment/platform.

They are divided in three sections:

Data import services: designed to help in the task of massive data import into the Triskell environment, mainly for initial and incremental data loads.
Service Proxies: allowing invoking Triskell Operation or CRUD Services.
Swagger page(s): providing access to the documentation of the new REST APIs. These REST APIs can be accessed by any Triskell user, not only the “REST API Client” users.

Client implementations for JAVA and/or VBA are provided for the first two types of services, but not for the newer Swagger-enabled REST APIs, where the Swagger page(s) should provide enough information to build a REST Client.

All the REST APIs explicitly described in this document (and not exposed in Swagger) are fully supported and we have no plan to decommission them – however, we do no plan to make significant improvements to them in the future, as our focus is to expand the new Swagger-enabled REST APIs.

As a result, if you’re building a new integration with Triskell, you should favor using the new Swagger-exposed REST APIs whenever one matching your requirements is available.

Usually, Web services are designed to manage small set of data.

If you are not sure they will cover your requirements, please contact us at:

support@triskellsoftware.com.

3 Authentication

From the authentication point of view, there are two kinds of web services on Triskell: stateful and stateless.

Most of the REST services provided are Stateful, which means that interacting with them requires a login first.

On the other hand, Stateless services will do a user authentication on every call.

Stateless services are intended to be used from clients not capable of managing a session cookie to maintain a dialog with the server.

In this document, only Stateless services will be denoted, most of the services being Stateful by default.

All REST APIs listed in Swagger can be used with both Stateless (API Key) and Stateful (Login/Logout) authentication

Two services are provided to log in and log out of Triskell.

Stateless services must provide their authentication parameters as HTTP Headers on every service call.

3.1 Stateless Authentication (API Key)

Stateless services must provide their authentication parameters as HTTP Headers on every service call. This must be done by passing the following two HTTP Headers with every request:

X-Account-Name: username@tenantdomain

X-API-Key: Your_Triskell_API_Key

Sessions created for these calls will be automatically closed when the call completes, so you do not need to log out.

3.2 Login Service

The login service must be invoked before any other stateful Triskell web service call. It receives a user identifier and a password as URL parameters.

There are 3 distinct implementations: GET, POST and JSON.

3.2.1 GET

URL

https:// SERVER /triskell/service/rest/login/user/{userId}/passwd/{pass}

HTTP Method

GET

URL Parameters

{ userId }: String containing user identifier as ‘user@tenant.com’

{ pass }: String containing a Hex encoded MD5 hash of the password

When login is successful it returns a HTTP response code ‘200 – OK’An authentication failure will return HTTP response code ‘401 – UNAUTHORIZED’

3.2.2 POST

URL

https:// SERVER /triskell/service/rest/login

HTTP Method

POST

FORM Parameters

user: String containing user identifier as ‘user@tenant.com’

password: String containing a Hex encoded MD5 hash of the password

When login is successful it returns a HTTP response code ‘200 – OK’An authentication failure will return HTTP response code ‘401 – UNAUTHORIZED’

3.2.3 JSON

URL

https:// SERVER /triskell/service/rest/loginJson

HTTP Method

POST

JSON Parameters

user: String containing user identifier as ‘user@tenant.com’

password: String containing a Hex encoded MD5 hash of the password

{

"user":"user@tenant.com",

"password":"1234567890ABCDEF"

}

When login is successful it returns a HTTP response code ‘200 – OK’An authentication failure will return HTTP response code ‘401 – UNAUTHORIZED’

3.2.4 API Key for Stateful login

You can also use API Key authentication to get a stateful session (same as for username/password login). This can be used as an alternative stateful login when users passwords have to be frequently rotated as part of the security policy.

URL	https:// SERVER/triskell/service/rest/login/apikey
HTTP Method	GET
HTTP Headers	X-API-Key: Your_Triskell_API_Key

You need to pass the two API Key authentication header with this call, however unlike with a standard Stateless REST API call, your Triskell session will not end after this call, and you will be able to use it for making more Stateful REST API calls with the same session.

Just like with standard Username/Password login, you need to logout once you finished using your session.

3.3 Logout Service

Logout service provided for closing the session at the server.

URL	URL: https:// SERVER /triskell/service/rest/logout
HTTP Method	GET

3.4 OAuth2

The Swagger-enabled REST APIs can use OAuth2 for authentication (more exactly, OAuth2.1), with support for these grant types:

authentication_code: You need to create a CLIENT_ID in Triskell, and users will authenticate with Triskell using their standard Triskell authentication (possibly SSO with 2FA if configured). This authorization flow can only be used by human users.

client_credentials: You need to create (and maintain) a CLIENT_ID and a CLIENT_SECRET in Triskell. They will be used during authentication, with no other interaction than the “OAuth2 dance” used to retrieve an authorization code. This authorization flow is advised to be used for all programmatic clients, and provides extra security over the Triskell API Key authentication.

As of Triskell 2026 SP2, you need to contact Triskell Support in order to get access to the configuration pages that will let you define Client IDs and Client Secrets. You will not be able to use OAuth2 for authentication until they are defined. Please contact us at:

support@triskellsoftware.com.

As of Triskell 2026 SP2, we will reset all issued OAuth2 tokens and codes upon server restart, which will typically happen on every week-end during the patch deployment maintenance window. Every time this happens, you won’t be able to re-use authorization codes and refresh tokens previously issued, and will need to re-perform the OAuth2 authentication flow from the start.
We plan to address this limitation in a future version.

For further details on OAuth2 authentication, please refer to the official OAuth2.1 specification.

3.5 API Key

There are 2 configuration toggles in the Configurator to control API Key feature. You can find them in “General Settings à Tenant Configuration”:

3.5.1 Enable API Key Authentication

This will be ON by default. If you turn it OFF, it will be impossible for any user (even REST Client users) to use API Key for authentication into Triskell. Note that you can still use username/password or OAuth2 authentication if it is disabled.

If you turn OFF API Key authentication while Zapier Integration or Triskell AI are enable, they will stop working as they rely on this way to authenticate into Triskell REST APIs.

3.5.2 Users can manage their API Keys

This feature is turned OFF by default. When turned ON, it allows all Triskell users to manage their own API Keys in their user profile’s “Preferences” menu:

At the bottom of the user’s Preferences page, select “API Key Configuration”:

This will open the window that lets user configure their API Keys. They can add, delete, and modify API Keys, as well as copy the value of any of the API Keys to their clipboard by clicking “Copy” next to the selected API Key value:

By default, newly created API Keys are Active and do not have an expiration date (never expire). If an API Key is inactivated or crosses its expiration date (if defined), it cannot be used anymore for authentication.

4 Data Import

These services are designed to import large amount of data import into a Triskell tenant in a reliable and performing way.

Requests and responses are exchanged as XML documents with the clients, to enforce data correctness and validation.

These services can only be called by a Configurator user.

Any call from an unprivileged user will be rejected.

4.1 Dataobject Structure

This Web service is capable of search DataObjects and importing complex dataobject structures into Triskell.

4.1.1 WS Dataobject Operation: Create

This WebService imports DataObjects into Triskell allowing adding to them:

Relationships with other dataobjects
Assign roles to users
Custom Attribute values
Nested dataobject children

The name of the dataobject must be provided (mandatory) by the user if the object of the dataobject to create don’t have a “Auto generate data object name format”. In this case the name must be provided in the field NAME of the XML.

On the opposite, if the object of the dataobject to create have a “generated code”, the name it’s not necessary (not mandatory), and can be empty in the field NAME of the XML. If the name is given to the dataobject, this name provided will be ignored and a new name will be generated by Triskell, just like in the configuration of the object. The name generated by Triskell will be returned in the response XML, in the field “name_generated”.

The dataobjectid will be also returned in the response XML, in the field “dataobjectid”.

If the object of the dataobject to create on his own configuration have marked as true the option “Use in Gantt?”, then at the time of the creation of the dataobject, it is also created the dataobject on the Gantt of the indicated parent dataobject. This feature it is not optional, to create data consistence on the system.

Another feature when creating the dataobject on the Gantt it is the possibility to send (or not) the Start/End date of the Item on the Gantt. To do that it is needed to send on the Custom Attribute values, the dates that are configured on the object to be used as “Gantt Chart Dates Set”. If they are provided, those dates are the ones used on the creation of the Item on the Gantt, if not, the Start date will be the current date and the End date the value of the current date plus the default duration value.

Another feature to consider is the default value of the Custom Attribute. If the object of the dataobject to create have one Custom Attribute that have a default value, that value will be added to the dataobject, just like it happens when a dataobject it is created by the front-end. This feature is not optional, to create data consistency on the system. If on the passed Attributes (on the XML) exists other value to the same Custom Attribute that have a default value, the passed Attribute will be inserted, instead of the default value.

Every top-level element and his nested children will be processed in a single transaction.

Any failure at child level will rollback all changes on the top-level element.

After a top-level element being processed successfully, failures at subsequent top-level elements will not affect its status.

URL	https:// SERVER /triskell/service/rest/dataobject/create
HTTP Method	POST

Here is a sample of the input XML doc containing a list of dataobjects with examples on relationships, roles, children and custom attributes:

<?xml version="1.0" encoding="UTF-8"?>

<OBJECT>Project</OBJECT>

<DESCRIPTION>Implement ISO 14 000 (evaluation year1 Implementation Y2-3)</DESCRIPTION>

<STAGE>1.Initiation</STAGE>

<NAME>Start Date</NAME>

</ATTRIBUTE>

<NAME>Finish date</NAME>

</ATTRIBUTE>

<NAME>Exp. Benefits</NAME>

</ATTRIBUTE>

<VALUE>2.In Progress</VALUE>

</ATTRIBUTE>

<NAME>Region</NAME>

<VALUE>3.Japan</VALUE>

</ATTRIBUTE>

<NAME>Goals</NAME>

<VALUE>To create a data object via rest operation</VALUE>

</ATTRIBUTE>

</ATTRIBUTES>

<TYPE>Client</TYPE>

</RELATIONSHIP>

</RELATIONSHIPS>

<USER_ROLES>

<USER_ROLE>

<ROLE>Project Manager</ROLE>

<USER_CODE>Silva</USER_CODE>

</USER_ROLE>

</USER_ROLES>

<OBJECT>Work Package</OBJECT>

<NAME>Package 001</NAME>

<STAGE>1.Active</STAGE>

<POOL>parent</POOL>

<USER_ROLES></USER_ROLES>

<POOL>parent</POOL>

<USER_ROLES> ... </USER_ROLES>

</DATAOBJECT>

<POOL>parent</POOL>

<USER_ROLES> ... </USER_ROLES>

</DATAOBJECT>

</CHILDS>

</DATAOBJECT>

</CHILDS>

</DATAOBJECT>

</DATAOBJECTS>

It returns an XML with a list of results codes OK/KO for every dataobject into the request, including an error description on failures.

<?xml version='1.0' encoding='UTF-8'?>

<name_generated></name_generated>

</dataobject>

<name_generated></name_generated>

</dataobject>

<name>Package 001</name>

<name_generated></name_generated>

</dataobject>

<name_generated>PRJ 046</name_generated>

</dataobject>

</dataobjects>

4.1.2 WS Dataobject Operation: Search

This operation searches for dataobjects having their URL parameter {at} equals to the provided String at the URL parameter {toSearch}, with the exception of the option ‘CHILDS’ that returns all dataobjects having as parent the dataobject identified by id at {toSearch}.

URL

https:// SERVER /triskell/service/rest/dataobject/search/{toSearch}/at/{at}

HTTP Method

GET

URL Parameters

{at}:

NAME: search dataobjects by name
DESCRIPTION: search dataobjects by description
CHILDS: Obtain all dataobject children by his identifier

It returns an XML document containing dataobject nodes with his name and identifier.

4.1.3 Java Client

The Triskell Dataobject WS client for JAVA will be provided in an Eclipse project containing all the needed classes and dependencies.

Three client versions are provided for working with: XML Documents as String, W3C documents and Xom documents.

Package

eu.triskell.ws.rest.client.businessDelegate.dataObject

Class

DataObjectBD<E>

Direct Known Subclasses

DataObjectBDString

DataObjectBDW3CDom

DataObjectBDXom

Constructor Summary

protected

DataObjectBD(Conversation c, java.lang.Class<E> clazz)

Constructor with a Conversation object that will manage the state against the server.

Method Summary
E	create(E doc) Receives a xml like: <DATAOBJECTS> <DATAOBJECT>...
E	searchAt(java.lang.String search, java.lang.String at) Search any.
E	searchByDescription(java.lang.String desc) Search Dataobjects by Description.
E	searchByName(java.lang.String name) Search Dataobjects by Name.
E	searchChildsOf(java.lang.Long id) Search Dataobjects nesting the given dataobjectId.

This is an example on how to call the create operation with the JAVA client:

Conversation conversation = null;

try {

conversation = new Conversation("https://ondemand.triskellsoftware.com");

conversation.logOn("admin@tenant.com", "aeiou123");

} catch (TkRestClientException e) {

e.printStackTrace();

return;

}

DataObjectBDW3CDom dobd = new DataObjectBDW3CDom(conversation);

org.w3c.dom.Document request = buildRequestDocument(),

response;

response = dobd.create(request);

4.2 Users

This Web Service allows to create and to search Triskell lists of user/login.

4.2.1 WS Users Operation: Create

This operation creates users/logins into a Triskell tenant.

URL	https:// SERVER /triskell/service/rest/user/create
HTTP Method	POST

It accepts a list of users into an XML with the following structure:

<?xml version="1.0">

<USERS>

<USER>

<EMAIL>foo.bar@barfoo.eu</EMAIL>

<PASSWORD>AEIOU123</PASSWORD>

<LANGUAGE>English</LANGUAGE>

<CALENDAR>Company Calendar</CALENDAR>

<ARCHIVED>(off / false / 0)</ARCHIVED>

<CONFIGURATOR>(off / false / 0)</CONFIGURATOR>

<DEFAULT_STARTPAGE>Timesheet Page</DEFAULT_STARTPAGE>

<PME>

<START_DATE>2020.10.01</START_DATE>

</PME>

</USER>

<USER>

...

</USER>

...

</USERS>

Another accepted XML structure:

<?xml version="1.0" encoding="UTF-8"?>

<USERS>

<USER>

<NAME>USER TESTE</NAME>

<EMAIL>teste@gmail.com</EMAIL>

<PASSWORD>AEIOU123</PASSWORD>

<CALENDAR>Company Calendar</CALENDAR>

<ARCHIVED>false</ARCHIVED>

<CONFIGURATOR>false</CONFIGURATOR>

<NAME>teste</NAME>

<START_DATE>2025-02-01</START_DATE>

</ATTRIBUTE>

<NAME>teste2</NAME>

<START_DATE>2025-05-01</START_DATE>

</ATTRIBUTE>

</ATTRIBUTES>

</USER>

</USERS>

It returns an XML with a list of results codes OK/KO for every user into the request, including an error description on failures:

<?xml version="1.0"?>

<users>

<user>

</user>

<user>

<error>description</error>

</user>

<users>

Customer can do more than one request on the same REST conversation depending on your functional needs. This feature should not be used to load big data volumes because during the REST conversation Triskell users can get blocked processing the request, so we suggest using it with common sense in terms of data volume and scheduling. Triskell will limit the number of requests by day in the future to avoid collapsing the server, so please take this in account when developing your interfaces.

4.2.1.1 Fields description

4.2.1.1.1 Mandatory fields

code: unique user identifier used as a login (String).
name: the name to the user (String).
password: the password of the user to make login (String).
md5password / hashpassword: the password of the user in SHA256 format to make login (String). *
languageCode: unique identifier of the language to be used by the user (String).
calendar: unique identifier of the default calendar of the user (String).

NOTE: Both md5password and hashpassword are accepted, though the password itself has to be in the SHA256 format. Passwords in the md5 format are no longer accepted.

4.2.1.1.2 Optional fields

email: the email of the user (String).
active: Boolean value (true/false).
archived: Boolean value (true/false).
configurator: Boolean value (true/false).
default_startPage: unique identifier of the default start page to the user (String). Have fixed and dynamic values.
- Fixed:
  - Application Home Page
  - Management Structures Page
  - Portfolios Page
  - Portfolio Items Page
  - Custom Components Page
  - Management Entities Page
  - Timesheet Page
  - Calendar Page
  - Reports Page
- Dynamic:
  - The name of the Object available with the option “Show Opt in Main Menu” with value YES on is definition (Ex: Project, Milestone…)
timesheet: Boolean value (true/false).
canenteronnonworkingdays: Boolean value (true/false).
allownpas: Boolean value (true/false).
minValue: Big Decimal value with decimal separator “.” and no thousands separator.
maxValue: Big Decimal value with decimal separator “.” and no thousands separator.
defaultValue: Big Decimal value with decimal separator “.” and no thousands separator.
PME: group of fields to add the Primary Management Entity of the user.
- name: unique name identifier of the DataObject to use as a PME.
- start_date: unique Date in the day format (String). The Date must be in the format “YYYY.MM.DD” to work, without hours, minutes and seconds.
Attributes: group of fields to associate existing Custom Attributes to the user.
- Name: unique name identifies of the Custom Attribute name.
- Value: the pretended value from the List Data Values of the Attribute.
- Start_Date: unique Date in the “YYYY-MM-DD” format to set where the attribute starts from. *

NOTE: If the value of the default_startPage is dynamic, and the user does not have any role to access to that Object, it will be loaded the Application Home Page instead.

NOTE: Only available for attributes with the “List History” option activated. If values are inputed for attributes with this option deactivated, it will have no effect. If no value is given, the Date will default to 01-01-1970.

4.2.1.2 User Creation example

There are some examples available about how to send information to Triskell using Bruno plug-in, from Bruno Software Inc. You can get Bruno free here. Then you just need to import the attached file " TriskellAPI.yml ", then look to the UserCreation section. Also, the file “NextRelease-environment.json”. The last file is used to set environment variables, so it can be easily tested on different environments.

4.2.2 WS Users Operation: Search

This operation search for users having active the flag provided at the URL parameter {what}.

URL

https:// SERVER /triskell/service/rest/user/search/{what}

HTTP Method

GET

URL Parameters

ALL: All tenant Users
ACTIVE: All active Users
ARCHIVED: All archived Users

Example for searching all users:

HTTPS:// SERVER /triskell/service/rest/user/search/ALL

It returns a XML document with a list of users matching the condition:

<?xml version="1.0">

<USERS>

<USER>

<EMAIL>foo.bar@barfoo.eu</EMAIL>

<CALENDAR>Company Calendar</CALENDAR>

<ARCHIVED>(off / false / 0)</ARCHIVED>

<CONFIGURATOR>(off / false / 0)</CONFIGURATOR>

</USER>

...

</USERS>

4.2.3 WS Users Operation : Search At

This operation search for users having his URL parameter {where} equals to the provided String at the URL parameter {toSearch}.

URL

https:// SERVER /triskell/service/rest/user/search/{toSearch}/at/{where}

HTTP Method

GET

URL Parameters

{where}:

NAME: User Name/Description
CODE: User Code/Login (without tenant domain)

Example for searching a user called John Smith:

https:// SERVER /triskell/service/rest/user/search/John%20Smith/at/NAME

It returns a XML document with a list of users matching the condition:

<?xml version="1.0">

<USERS>

<USER>

<EMAIL>foo.bar@barfoo.eu</EMAIL>

<CALENDAR>Company Calendar</CALENDAR>

<ARCHIVED>(off / false / 0)</ARCHIVED>

<CONFIGURATOR>(off / false / 0)</CONFIGURATOR>

</USER>

...

</USERS>

4.2.4 WS Users Java Client

The Triskell User WS client for JAVA will be provided into an Eclipse project containing all the needed classes and dependencies.

Three client versions are provided for working with: XML Documents as String, W3C documents and Xom documents.

Package

eu.triskell.ws.rest.client.businessDelegate.user

Class

UserBD<E>

Direct Known Subclasses

UserBDString

UserBDW3CDom

UserBDXom

Business Delegate for accessing the Triskell User Rest Services:

Constructor Summary

protected

UserBD(Conversation c, java.lang.Class<E> clazz)

Constructor with a Conversation object that will manage the state against the server.

Method Summary
E	create(E doc) Receives a xml
E	getActive`()` Returns all the tenant Active users.
E	getAll() Returns all the tenant users.
E	getArchived() Returns all the tenant Archived users.
E	searchAt(java.lang.String search, java.lang.String at) Search any.
E	searchByCode(java.lang.String code) Search a user by code.
E	searchByName(java.lang.String name) Search a user by name.

This is an example on how to call the create operation with the JAVA client:

Conversation conversation = null;

try {

conversation = new Conversation("https://ondemand.triskellsoftware.com");

conversation.logOn("admin@tenant.com", "aeiou123");

} catch (TkRestClientException e) {

e.printStackTrace();

return;

}

UserBDW3CDom usbd = new UserBDW3CDom (conversation);

org.w3c.dom.Document request = buildRequestDocument(), response;

response = usbd.create(request);

4.3 Custom Attribute List Values

This web service allows adding values into an existing Custom Attribute of type List.

4.3.1 WS AttrListVal Operation: Create

This operation adds new values into an existing ‘Custom Attribute List’ into a Triskell tenant. These values can be all at the same level or in a future to a nested on a tree configuration.

URL	https:// SERVER /triskell/service/rest/cutomAttributeListValues/create/at/{attrId}
HTTP Method	POST
URL Parameters	{ attrId } is a numerical identifier of a custom attribute of type list

It accepts a list of values for an existing ‘Custom Attribute List’ into an XML with the following structure:

<?xml version="1.0"?>

<active> true/false </active>

<archived> true/false </archived>

<defaultvalue> true/false </defaultvalue>

<selectable> true/false </selectable>

<label> The Label </label>

<comment> A comment </comment>

<backgroundColor> RGB #FFFFFF </backgroundColor>

<fontColor> RGB #FFFFFF </fontColor>

<previewImageExtension> The image extension: PNG, GIF, BMP ... </previewImageExtension>

<imageByteBuffer> Base64 encoded image byte array </imageByteBuffer>

<!--

<active> true/false </active>

<archived> true/false </archived>

<defaultvalue> true/false </defaultvalue>

<selectable> true/false </selectable>

<label> The Label </label>

<comment> A comment </comment>

<backgroundColor> RGB #FFFFFF </backgroundColor>

<fontColor> RGB #FFFFFF </fontColor>

<previewImageExtension> extension: PNG, GIF, BMP ... </previewImageExtension>

<imageByteBuffer> Base64 encoded image byte array </imageByteBuffer>

</CustomAttrListValue>

</childs>

<-->

</CustomAttrListValue>

</CustomAttrListValues>

Customer can do more than one request on the same REST conversation depending on your functional needs. This feature should not be used to load big data volumes because. During the REST conversation Triskell users can get blocked processing the request, so we suggest using it with common sense in terms of data volume and scheduling. Triskell will limit the number of requests by day in the future to avoid collapsing the server, so please take this in account when developing your interfaces.

The answer of this request will return some data of the Custom Attribute Value List created. The user can do what they want with that information. The answer is one XML with the structure in an Array of the values created.

This is the fields returned by the answer:

label
sequence
customattrlistvalueid
result

This is one example of the answer:

<?xml version="1.0"?>

</customattrlistvalue>

</customattrlistvalue>

</customattrlistvalues>

4.3.1.1 Fields description

4.3.1.1.1 Mandatory fields

attrId: unique Custom Attribute identifier (Integer). This must be an ID of one Custom Attribute List.
label: the value for the label to the Custom Attribute List Value (String).

4.3.1.1.2 Optional fields

active: Boolean value (true/false).
archived: Boolean value (true/false).
defaultvalue: Boolean value (true/false).
selectable: Boolean value (true/false).
scoreval: Integer value to be the Score.
comment: String value.
backgroundColor: String value in the #RGB format.
fontColor: String value in the #RGB format.
previewImageExtension: String value.
imageByteBuffer: String value with the file encoded in Base64.

4.3.2 WS AttrListVal Operation: update

This operation allows update values in an existing ‘Custom Attribute List’ into a Triskell tenant. These values must be all at the same level or in a future to a nested on a tree configuration.

URL	https:// SERVER /triskell/service/rest/cutomAttributeListValues/update/at/{attrId}
HTTP Method	POST
URL Parameters	{ attrId } is the a numerical identifier of a custom attribute of type list

It accepts a list of values for an existing ‘Custom Attribute List Values’ into an XML with the following structure:

<?xml version="1.0"?>

<archived>false</archived>

<selectable>false</selectable>

<comment>Now Have this comment AAA</comment>

<!--

<backgroundColor> RGB #FFFFFF </backgroundColor>

<fontColor> RGB #FFFFFF </fontColor>

<previewImageExtension> The image extension: PNG, GIF, BMP ... </previewImageExtension>

<imageByteBuffer> Base64 encoded image byte array </imageByteBuffer>

-->

</CustomAttrListValue>

<active>false</active>

<defaultvalue>false</defaultvalue>

<comment>Now Have this comment BBB</comment>

<imageByteBuffer> Base64 encoded image byte array </imageByteBuffer>

</CustomAttrListValue>

</CustomAttrListValues>

Customer can do more than one request on the same REST conversation depending on your functional needs. This feature should not be used to load/update big data volumes because. During the REST conversation Triskell users can get blocked processing the request, so we suggest using it with common sense in terms of data volume and scheduling. Triskell will limit the number of requests by day in the future to avoid collapsing the server, so please take this in account when developing your interfaces.

This is the fields returned by the answer:

label
sequence
customattrlistvalueid
result

This is one example of the answer:

<?xml version="1.0"?>

</customattrlistvalue>

</customattrlistvalue>

</customattrlistvalues>

4.3.2.1 Fields description

4.3.2.1.1 Mandatory fields

attrId: unique Custom Attribute identifier (Integer). This must be an ID of one Custom Attribute List.
customattrlistvalueid: unique Custom Attribute List Value identifier (integer). This must be an ID of one value from the previous attrId.
label: the value for the label to the Custom Attribute List Value (String).

4.3.2.1.2 Optional fields

active: Boolean value (true/false).
archived: Boolean value (true/false).
defaultvalue: Boolean value (true/false).
selectable: Boolean value (true/false).
scoreval: Integer value to be the Score.
comment: String value.
backgroundColor: String value in the #RGB format.
fontColor: String value in the #RGB format.
previewImageExtension: String value.
imageByteBuffer: String value with the file encoded in Base64.

Some of this optional fields have a default value, and if the value is not sent in the update call, it will be updated to the default value. See the comments in the XML example above.

These are fields with default values and the respect default value:

active: true
archived: false
defaultvalue: false
selectable: true
scoreval: 0
backgroundColor: #FFFFFF (white)
fontColor: #000000 (black)

4.3.3 WS AttrListVal Java Client

The Triskell CustomAttributeListValues WS client for JAVA will be provided into an Eclipse project containing all the needed classes and dependencies.

Three client versions are provided for working with: XML Documents as String, W3C documents and Xom documents.

Package

eu.triskell.ws.rest.client.businessDelegate.customAttributeListValues

Class

CustomAttributeListValuesBD<E>

Direct Known Subclasses

CustomAttributeListValuesBDString

CustomAttributeListValuesBDW3CDom

CustomAttributeListValuesBDXom

Constructor Summary

protected

CustomAttributeListValuesBD(Conversation c, java.lang.Class<E> clazz)

Constructor with a Conversation object that will manage the state against the server.

Method Summary

create(java.lang.Integer attrId, E doc)

Receives an xml like:
<CustomAttrListValues>.

<active> true/false </active>

<archived> true/false </archived>

<defaultvalue> true/false </defaultvalue>

<selectable> true/false </selectable>

<label> The Label </label>

<comment> A comment </comment>

<backgroundColor> RGB #FFFFFF </backgroundColor>

<fontColor> RGB #FFFFFF </fontColor>

<previewImageExtension> The image extension : PNG, GIF, BMP ...

This is an example on how to call the create operation with the JAVA client:

Conversation conversation = null;

try {

conversation = new Conversation("https://ondemand.triskellsoftware.com");

conversation.logOn("admin@tenant.com", "aeiou123");

} catch (TkRestClientException e) {

e.printStackTrace();

return;

}

CustomAttributeListValuesBDW3CDom cattrbd = new CustomAttributeListValuesBDW3CDom(conversation);

org.w3c.dom.Document request = buildRequestDocument(),

response;

response = cattrbd.create(123, request); /* 123 is the custom attribute identifier */

4.4 Gantt Custom Component Create

This web service allows add Gantt custom components to an existing dataobject.

It will run only if it's properly configured.
It does not update existing Gantt custom components.
It's only available if dataobject doesn't have Gantt custom component yet.
It requires an initial login authentication and it's only accessible for configurator users.

This service is different from standard dataobjects creation because its behavior is completely specific. So please do not use dataobjects web service creation to create Gantt custom components.

URL	URL: https:// SERVER /triskell/service/rest/tasks/create
HTTP Method	POST

It accepts an xml with the following schema:

<?xml version="1.0" encoding="UTF-8"?>

<xsd:schema xmlns="https://ondemand.triskellsoftware.com/xsd/tasks"

xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="https://ondemand.triskellsoftware.com/xsd/tasks">

<xsd:annotation>

<xsd:documentation>Xml definition Tasks RESTful WebService

</xsd:documentation>

</xsd:annotation>

<xsd:element name="dataobjects" type="dataobjectsType" />

<xsd:complexType name="attributeType">

<xsd:sequence>

<xsd:element type="xsd:string" name="name" />

<xsd:element type="xsd:string" name="value" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="attributesType">

<xsd:sequence>

<xsd:element type="attributeType" name="attribute"

maxOccurs="unbounded" minOccurs="0" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="dataobjectType">

<xsd:sequence>

<xsd:element type="xsd:string" name="taskid" />

<xsd:element type="xsd:string" name="name" />

<xsd:element type="xsd:date" name="StartDate" />

<xsd:element type="xsd:date" name="EndDate" />

<xsd:element type="xsd:int" name="Duration" />

<xsd:element type="xsd:string" name="DurationUnit" />

<xsd:element type="xsd:string" name="SchedulingMode" />

<xsd:element type="xsd:date" name="actualStart" minOccurs="0" />

<xsd:element type="xsd:date" name="actualEnd" minOccurs="0" />

<xsd:element type="xsd:float" name="Effort" />

<xsd:element type="xsd:string" name="EffortUnit" />

<xsd:element type="xsd:decimal" name="PercentDone" />

<xsd:element type="attributesType" name="attributes" minOccurs="0" />

<xsd:element type="childTasksType" name="childTasks" minOccurs="0" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="childTasksType">

<xsd:sequence>

<xsd:element type="dataobjectType" name="dataobject"

maxOccurs="unbounded" minOccurs="0" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="dataobjectsType">

<xsd:sequence>

<xsd:element type="xsd:string" name="object" />

<xsd:element type="xsd:string" name="name" />

<xsd:element type="childTasksType" name="childTasks" />

</xsd:sequence>

</xsd:complexType>

</xsd:schema>

This is a XML example:

<?xml version='1.0' encoding='UTF-8'?>

<p:dataobjects xmlns:p="https://ondemand.triskellsoftware.com/xsd/tasks"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="https://ondemand.triskellsoftware.com/xsd/tasks tasks.xsd">

<SchedulingMode>FixedDuration</SchedulingMode>

<SchedulingMode>FixedDuration</SchedulingMode>

<name>Attribute name</name>

<value>Value</value>

</attribute>

</attributes>

</dataobject>

<SchedulingMode>FixedDuration</SchedulingMode>

<name>Attribute name</name>

<value>Value</value>

</attribute>

</attributes>

</dataobject>

</childTasks>

</dataobject>

</childTasks>

</p:dataobjects>

Here is the description for some of these fields:

Taskid: is a string unique identifier for every task. It's not a Triskell identifier and it's required to manage the web service response. It won't be stored in Triskell.
Date fields are in ISO format (YYYY-MM-DD).
Units allowed values:
h: hours
d: days
Scheduling Modes allowed values:
FixedDuration
EffortDriven
DynamicAssignment

This is a response example (XML):

<?xml version='1.0' encoding='UTF-8'?>

<data>

</data>

<data>

</data>

</dataobjects>

If all results are ok and you access your Triskell environment you can see the data loaded:

Data will be "normalized" after Gantt reloading applying Triskell Gantt rules and calendar. It can produce some differences between the request and displayed data.

This web service version only allows load text Gantt custom component attributes.

No Java Client is provided to use this service but you can find a request example on Triskell-ImportTasks.xlsm.

4.5 Timesheet Create

This web service allows add/update timesheet data.

It will only apply if it's properly configured.
It requires an initial login authentication and it's only accessible for configurator users.
It's only available to load daily data.

URL	URL: https:// SERVER /triskell/service/rest/timesheet/create
HTTP Method	POST

It accepts an xml with the following schema:

<?xml version="1.0" encoding="UTF-8"?>

<xsd:schema xmlns="https://ondemand.triskellsoftware.com/xsd/timesheet"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

targetNamespace="https://ondemand.triskellsoftware.com/xsd/timesheet">

<xsd:annotation>

<xsd:documentation>Xml definition 4 Timesheet RESTful WebService</xsd:documentation>

</xsd:annotation>

<xsd:element name="timesheets" type="UserListType"/>

<xsd:complexType name="UserListType">

<xsd:sequence>

<xsd:element name="user" type="UserType" minOccurs="1" maxOccurs="1" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="UserType">

<xsd:sequence>

<xsd:element name="type" type="xsd:string" minOccurs="0" maxOccurs="1" />

<xsd:element name="value" type="xsd:string" minOccurs="1" maxOccurs="1" />

<xsd:element name="object" type="ObjectType" minOccurs="1" maxOccurs="unbounded" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="ObjectType">

<xsd:sequence>

<xsd:choice maxOccurs="1" minOccurs="1">

<xsd:element name="path" type="xsd:string" minOccurs="1" maxOccurs="1" />

<xsd:element type="xsd:int" name="dataobjectId" maxOccurs="1" minOccurs="1"/>

</xsd:choice>

<xsd:element name="timesheet" type="DataListType" minOccurs="1" maxOccurs="1" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="DataListType">

<xsd:sequence>

<xsd:element name="data" type="DataType" minOccurs="1" maxOccurs="unbounded" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="AttributeType">

<xsd:sequence>

<xsd:element name="name" type="xsd:string" minOccurs="1" maxOccurs="1" />

<xsd:element name="value" type="xsd:string" minOccurs="1" maxOccurs="1" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="AttributesListType">

<xsd:sequence>

<xsd:element name="attribute" type="AttributeType" maxOccurs="5" />

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="DataType">

<xsd:sequence>

<xsd:element name="timesheetid" type="xsd:string" minOccurs="1" maxOccurs="1" />

<xsd:element name="attributes" type="AttributesListType" minOccurs="0" maxOccurs="1" />

<xsd:element name="value" type="xsd:date" minOccurs="1" maxOccurs="1" />

<xsd:element name="units" type="xsd:float" minOccurs="1" maxOccurs="1" />

<xsd:element name="etc" type="xsd:float" minOccurs="1" maxOccurs="1" />

<xsd:element name="comment" type="xsd:string" minOccurs="0" maxOccurs="1" />

</xsd:sequence>

</xsd:complexType>

<xsd:simpleType name="ValueType">

<xsd:restriction base="xsd:string">

<xsd:pattern value="\s{0}[_A-Z0-9]+\s{0}" />

</xsd:restriction>

</xsd:simpleType>

</xsd:schema>

This is an XML example:

<p:timesheets xmlns:p="https://ondemand.triskellsoftware.com/xsd/timesheet" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://ondemand.triskellsoftware.com/xsd/timesheet timesheet-1.0.xsd ">

<user>

<path>Global IT Portfolio/Project 01/Module 1/Task 1</path>

<data>

<name>Billable?</name>

</attribute>

</attributes>

<comment>This comment was inserted by REST on the creation</comment>

</data>

<data>

<name>Billable?</name>

</attribute>

</attributes>

</data>

<data>

<name>Billable?</name>

</attribute>

</attributes>

</data>

</timesheet>

</object>

</user>

</p:timesheets>

Here is the description for some of these fields:

Type: The field name used to find/get the user (optional)*
- Possible values: name, login
Value: The name or the login (indicated in the Type) of the user to create/update the timesheet (mandatory)
Path: Complete path for a custom component. Separator "/". (can be replaced with the dataobjectId)
dataobjectId: is a unique identifier of the data object to locate it (can be replaced with the path)*
timesheetid: is a unique string identifier for a timesheet request. (mandatory)
Date field is ISO format (YYYY-MM-DD)
Comment: is a string with the comment to insert on the timesheet creation (optional)

*Note: The Type is an optional field, so if it is not added to the call it will find/get the user by his name, just like in the previous version of this REST service. This is to be retro-compatible with the previous version and clients don’t need to make any change on their implementations.

*Second note: To search by dataobjectId, the <path> element in the previous example should be replaced with <dataobjectId> containing the associated ID. Either one or the other must be provided. Both fields together or neither are not accepted.

This is a response XML example:

<?xml version='1.0' encoding='UTF-8'?>

<data>

</data>

<data>

</data>

<data>

</data>

</timesheets>

This web service only allows daily data

No Java Client is provided to use this service

4.6 Timephased Attribute Data

This web service allows add/update timephased data.

It will only apply if it's properly configured.
It requires an initial login authentication and it is accessible for all Triskell users and it will take it account same security rules.
It's only available to load monthly data.

URL	URL: https:// SERVER /triskell/service/rest/timephased/update
HTTP Method	POST

It accepts an xml with the following schema (To be changed in the future):

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="timephased">

<xs:complexType>

<xs:sequence>

<xs:element type="xs:int" name="object"/>

<xs:element type="xs:int" name="timephased_attribute"/>

<xs:element type="xs:int" name="rate_type"/>

<xs:element type="xs:string" name="path"/>

<xs:element type="xs:string" name="name"/>

<xs:element type="xs:boolean" name="use_editable_from" minOccurs="0" maxOccurs="1"/>

<xs:element name="version" maxOccurs="unbounded" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element type="xs:string" name="name"/>

<xs:element name="year" maxOccurs="unbounded" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element type="xs:short" name="value"/>

<xs:element name="month" maxOccurs="unbounded" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element type="xs:short" name="value"/>

<xs:element name="row" maxOccurs="unbounded" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element type="xs:int" name="id"/>

<xs:element name="attributes">

<xs:complexType>

<xs:sequence>

<xs:element name="attribute" maxOccurs="unbounded" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element type="xs:string" name="name"/>

<xs:element type="xs:string" name="value"/>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element type="xs:string" name="comments" maxOccurs="1" minOccurs="0"/>

<xs:element type="xs:string" name="additional_comments" maxOccurs="1" minOccurs="0"/>

<xs:element type="xs:float" name="amount"/>

<xs:element type="xs:string" name="unit"/>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:schema>

This is an XML example:

<?xml version='1.0' encoding='UTF-8'?>

<timephased_attribute>363</timephased_attribute>

<rate_type>0</rate_type>

<path>IT Portfolio</path>

<use_editable_from>true</use_editable_from>

<name>Forecast</name>

<year>

<month>

<row>

<name>ATTRID_346</name>

<value>1.Europe</value>

</attribute>

<name>ATTRID_362</name>

<value>1.Labor Cost</value>

</attribute>

</attributes>

<comments>This is a comment</comments>

<additional_comments>This is an additional comment</additional_comments>

</row>

</month>

<month>

<row>

<name>ATTRID_346</name>

<value>1.Europe</value>

</attribute>

<name>ATTRID_362</name>

<value>1.Labor Cost</value>

</attribute>

</attributes>

<comments>This is a comment</comments>

<additional_comments>This is an additional comment</additional_comments>

</row>

</month>

</year>

<year>

<month>

<row>

<name>ATTRID_346</name>

<value>1.Europe</value>

</attribute>

<name>ATTRID_362</name>

<value>1.Labor Cost</value>

</attribute>

</attributes>

</row>

</month>

<month>

<row>

<name>ATTRID_346</name>

<value>1.Europe</value>

</attribute>

<name>ATTRID_362</name>

<value>1.Labor Cost</value>

</attribute>

</attributes>

</row>

</month>

</year>

</version>

</timephased>

Here is the description for some of these fields:

object: Object unique identifier provided by Triskell.
timephased_attribute: Attribute unique identifier provided by Triskell.
rate_type: Rate type unique identifier provided by Triskell.
path: Complete path for a custom component. Separator "/".
name: Case sensitive name of the DataObject to use.
use_editable_from: Boolean to the service take in care the Editable From date or not. If set to true, the data before the Editable From will not be changed, even if it has changes on the XML. If set to false, all the data will be deleted and inserted.
version name: case sensitive using the name of the version in Triskell.
row: unique identifier by request.
unit: case sensitive with same options than on Triskell.
Attributes: name and value can be taken from Triskell custom attributes definition or from tenant_vw_attributes_list view on reporting module.
Comments: this option is available when the timephased attribute is “Multi line with comments”. It’s optional but it’s part of the key for a timephased row.
Additional comments: this option is available when the timephased attribute is “Additional comment”. It’s optional and it’s not part of the key and it should be included for the same timephased row when needed.

This is a response XML example:

<?xml version='1.0' encoding='UTF-8'?>

<data>

</data>

<data>

</data>

<data>

<error>Invalid Name and Path</error>

</data>

</timephased>

This web service will override all version data for each object

Information should be shorted by version, year and month

No Java Client is provided to use this service

Excel example is provided on the documentation

5 Service Proxies

Service Proxies are a simple way of executing remote procedure calls on Triskell CRUD and Operation services.

Requests and responses are exchanged as JSON objects with the clients, to enhance easiness and interoperability.

The proxy input object DataRequest, is compound of the following properties:

Id: numerical identifier
Params: A simple JSON object containing only primitive type properties.
Objects: Array of JSON objects of any type.

These properties must be present into the object being it used or not.

Example of DataRequest:

{

'id' : 1 ,

'params' : {

"param_1":"A",

"param_2":2

} ,

'objects' : [

{"NAME":"OBJECT_1"},

{"NAME":"OBJECT_2"}

]

}

The proxy output object Result, is compound of the following properties:

success: Boolean indicating successfulness of the request.
message: Error description.
resultType: Numerical identifier, error severity (1-OK, 2–Warning, 3-Error)
data: a String or a JSON object
id: a numerical identifier
authash: session identifier
executime: service execution time in nanoseconds
i18NParams and i18NMessageId: used on internationalized error message

Example of DataResult:

{

"authash":"dd06d7c94cd9a73f62b45c5b54247bce",

"executime":10997027,

"success":true,

"message":null,

"resultType":1,

"data":"Hello world !!!",

"id":0,

"i18NParams":[],

"i18NMessageId":""

}

5.1 Operation Service Proxy

This is a Web service to execute operations on a Triskell OperationService.

An OperationService groups related functionalities allowing to access then by his Operation Name.

OperationServiceProxy has two implementations, stateful and stateless.

5.1.1 Stateful Operation Service Proxy

Any stateful service requires a Login to be done before submitting any request to it.

5.1.2 WS Operation execute

Execute a service operation call. DataRequest is sent attached to the body of the HTTP request.

URL	URL: https:// SERVER /triskell/service/rest/proxy/operation/execute/{serviceName}/{operationName}
HTTP Method	POST
Content-Type Header	application/json
URL Parameters	{serviceName}: String containing the name of the service to be called {operationName}: String containing the Operation name

5.1.3 Stateless Operation Service Proxy

This web service does not require doing a previous Login on Triskell, a user authentication is done on every request.

5.1.4 WS Operation execute

Execute a service operation call. DataRequest is sent as a URL parameter.

URL	https:// SERVER /triskell/service/rest/proxy/operation/execute/{serviceName}/{operationName}/{payload}
HTTP Method	GET
Content-Type Header	X-Account-Name Header: Optional, username@tenantdomain X-API-Key Header: Optional
URL Parameters	{serviceName} : String containing the name of the service to be called {operationName} : String containing the Operation name {payload} : JSON DataRequest Object encoded in Base64

5.1.5 Java Client

The Triskell ServiceOperation client for JAVA will be provided into an Eclipse project containing all the needed classes and dependencies.

Package	eu.triskell.ws.rest.client.businessDelegate.operationService
Class	OperationServiceClient

Constructor Summary
OperationServiceClient(Conversation conv)

Method Summary
`DataResult`	execute`(java.lang.String serviceName, java.lang.String operationName)`
`DataResult`	execute(java.lang.String serviceName, java.lang.String operationName, DataRequest request)

This is an example on how to execute a ServiceOperation call from JAVA:

Conversation conversation = null;

DataResult res = null;

try {

conversation = new Conversation("https://ondemand.triskellsoftware.com");

conversation.logOn("admin@tenant.com", "aeiou");

} catch (TkRestClientException e) {

e.printStackTrace();

return;

}

try{

OperationServiceClient osc = new OperationServiceClient(conversation);

Map<String, String> params = new HashMap<String, String>();

params.put("PARAM_1", "X");

DataRequest dr = new DataRequest(params, 0);

res = osc.execute("ExampleService", "ExampleOperation", dr);

} catch (TkRestClientException e) {

e.printStackTrace();

}catch (Throwable e) {

e.printStackTrace();

} finally {

try {

conversation.logOff();

} catch (TkRestClientException e) {

e.printStackTrace();

return;

}

5.1.6 VBA Client

The Triskell ServiceOperation client for VBA will be provided into an Excel document containing all the needed classes and modules.

This is an example on how to execute a ServiceOperation call from VBA:

Dim osclient As New TkOperationServiceClient

Dim dataRequest As New TkDataRequest

Dim result As Dictionary

dataRequest.AddParameter "PARAM_1", "A"

dataRequest.AddParameter "PARAM_2", "B"

Set result = osclient.ExecuteWithData(pService:="ServiceName", _

pOperation:="OperationName", _

pDataRequest:=dataRequest)

6 Operational Services

6.1 Data Export (only data)

To export data from Triskell you need to use the reporting web service.

It's a proxied service (Please read documentation above). It requires previous standard authentication, using the login web service.

We are going to describe an example showing how to use this reporting service to extract data from Triskell easily.

First, you need to build a stored selector in Triskell. It’s not needed to add it to a report.

In this example, we are going to extract projects data that has been modified after a given date.

First, we need to create the parameter on Triskell reporting module:

We need this parameter id to add to our web service request so we need to display Id column:

Then we create a stored selector using these parameters:

We need to get the stored report id to run the query from a web service, so display the id column:

This is the query we use to build the stored selector:

SELECT *

FROM tenant_vw_PROJECT

where last_modified > ##FROM_DATE##

URL	URL: https:// SERVER /triskell/service/rest/proxy/operation/execute/ReportService/GetData
HTTP Method	POST
Content-Type Header	application/json
URL Parameters	JSON format

JSON request example:

{

'id': 0,

'params': {

"STORED_SELECTOR_ID":"24",

"valuesByParams":"3#2018.02.01"

} ,

'objects': null

}

Field description:

id: 0. It's required but not used for this service.
objects: null. It's required but not used for this service.
params:
- STORED_SELECTOR_ID: Required. It's your stored selector Id taken from Triskell.
- valuesByParams: Contains all report parameters. For each parameter the format is: {paramId}#{value}. You can concatenate several report params using "##" separator.

Example of JSON result:

{

"authash": "03663e556a63170e8fe3b40667f6e09f",

"executime": 118761151,

"success": true,

"messages": [],

"message": null,

"ret_i18n_code": "",

"ret_i18n_params": [],

"trace": null,

"resultType": 1,

"data": {

"isTruncatedResult": false,

"res": [

{

"$_$OwningDepartment": "AIIBE",

"$FCBudgetd": 127,

"$_$Successor": "",

"$_$Administrator": "* IT PMO",

"create_date": "11/13/2012",

"lifecycle": "5.Deployment",

"$ResProgress": 78.8,

"$ImpactBusOps": "High",

"$Platform": "Client-Server",

"$ImplementationRisk": "Medium",

"created_by": "** Global Configurator",

"$ITScorecard": "1.Corporate Contribution;3.Operational Excellence",

"dataobject_description": "Converse Platinum Xenon",

"$PoolActuals": 1502,

"$_$ProjectMembers": "07.Sean Pearson (IT User);Milo T. Riley;Tomas Osterhagen;Bernadette Hébert;Nicholas Richardson;Leo Watkins",

"role_dataobject_id": 1064,

"$Budgetk": 5620,

"$FCBudgetk": -530,

"$_$Application": "A-RAVEN",

"$_$ProjectSponsor": "",

"$Fin": "4.Some Issues",

"dataobject_name": "PRJ 001",

"$PoolAllocated": 5657.25,

"$Baselinestart": "",

"$Baselinefinish": "",

"dataobject_id": 1064,

"$_$Client": "Finance",

"root_name": "IT Portfolio",

"$Bus": "2.In Progress",

"$_$Initiatives": "BI 2015-001; BI 2015-002; BI 2015-004",

"root_id": 1025,

"$InitiativeCost": "High",

"$Finishdate": "12/31/2018",

"$Budgetd": 885,

"$Agile": "No",

"$PoolTaskAssignment": 6496.16,

"$Forecastd": 1012,

"last_modified": "02/13/2018",

"last_modified_by": "** Global Configurator",

"$Region": "1.Europe",

"rel_dataobject_id": 1064,

"$_$ProjectManager": "** Global Configurator;02.Uwe Seiler (PM)",

"$Forecastk": 5090,

"$ExpBenefits": 500,

"dataobject_parent_id": 1025,

"$FinProgress": 76.87,

"$Progress": "050",

"$Probability": 25,

"$Actualsd": 697.38,

"$Score": 5.8,

"$Weightedscore": 1.45,

"object_id": 82,

"$Tech": "1. On Top",

"$Actualsk": 4320,

"$ActivityType": "1. Corporate Projects",

"$StrategicImpact": "High",

"attr_dataobject_id": 1064,

"dataobject_parent_name": "IT Portfolio",

"currency_name": "Euro",

"object_name": "Project",

"$Status": "Excellent",

"$complete": 1.246737,

"$Risk": "3.Stable",

"$ImpactBusStrategy": "High",

"$StartDate": "10/02/2017",

"$_$FinancialController": "10.Samsa Leskinen (IT Fin.)"

{

"$_$OwningDepartment": "AIIBE",

"$FCBudgetd": -162.5,

"$_$Successor": "PRJ 011",

"$_$Administrator": "",

"create_date": "11/13/2012",

"lifecycle": "4.Testing",

"$ResProgress": 130.77,

"$ImpactBusOps": "High",

"$Platform": "Client-Server",

"$ImplementationRisk": "Low",

"created_by": "** Global Configurator",

"$ITScorecard": "3.Operational Excellence",

"dataobject_description": "Ralph Aluminium Stinger",

"$PoolActuals": 0,

"$_$ProjectMembers": "07.Sean Pearson (IT User);Milo T. Riley;Tomás Barros Silva;Bernadette Hébert",

"role_dataobject_id": 1065,

"$Budgetk": 2000,

"$FCBudgetk": -500,

"$_$Application": "A-RAVEN",

"$_$ProjectSponsor": "01.Bruce H. Trahan (IT Exec)",

"$Fin": "5.Critical",

"dataobject_name": "PRJ 002",

"$PoolAllocated": 1460,

"$Baselinestart": "07/01/2017",

"$Baselinefinish": "12/31/2018",

"dataobject_id": 1065,

"$_$Client": "Finance",

"root_name": "IT Portfolio",

"$Bus": "4.Some Issues",

"$_$Initiatives": "BI 2015-026",

"root_id": 1025,

"$InitiativeCost": "Moderate",

"$Finishdate": "12/31/2018",

"$Budgetd": 162.5,

"$Agile": "No",

"$PoolTaskAssignment": "",

"$Forecastd": 0,

"last_modified": "02/13/2018",

"last_modified_by": "** Global Configurator",

"$Region": "1.Europe",

"rel_dataobject_id": 1065,

"$_$ProjectManager": "02.Uwe Seiler (PM)",

"$Forecastk": 1500,

"$ExpBenefits": 600,

"dataobject_parent_id": 1025,

"$FinProgress": 0,

"$Progress": "080",

"$Probability": "",

"$Actualsd": 212.5,

"$Score": 7.8,

"$Weightedscore": 0,

"object_id": 82,

"$Tech": "1. On Top",

"$Actualsk": 0,

"$ActivityType": "2.Bus. Improvements",

"$StrategicImpact": "Medium",

"attr_dataobject_id": 1065,

"dataobject_parent_name": "IT Portfolio",

"currency_name": "Euro",

"object_name": "Project",

"$Status": "Excellent",

"$complete": 0,

"$Risk": "4.Some Issues",

"$ImpactBusStrategy": "Low",

"$StartDate": "07/01/2017",

"$_$FinancialController": ""

{

"$_$OwningDepartment": "DWDI",

"$FCBudgetd": -62.5,

"$_$Successor": "",

"$_$Administrator": "",

"create_date": "11/13/2012",

"lifecycle": "3.Development",

"$ResProgress": 80,

"$ImpactBusOps": "Low",

"$Platform": "DB Services",

"$ImplementationRisk": "Low",

"created_by": "** Global Configurator",

"$ITScorecard": "1.Corporate Contribution",

"dataobject_description": "Sphere Heliotrope Plato",

"$PoolActuals": "",

"$_$ProjectMembers": "",

"role_dataobject_id": 1080,

"$Budgetk": 700,

"$FCBudgetk": 100,

"$_$Application": "KRONOS",

"$_$ProjectSponsor": "",

"$Fin": "3.Stable",

"dataobject_name": "PRJ 017",

"$PoolAllocated": "",

"$Baselinestart": "07/01/2017",

"$Baselinefinish": "02/28/2019",

"dataobject_id": 1080,

"$_$Client": "Strategy",

"root_name": "IT Portfolio",

"$Bus": "1.On Top",

"$_$Initiatives": "BI 2015-028; BI 2015-030",

"root_id": 1025,

"$InitiativeCost": "Moderate",

"$Finishdate": "02/28/2019",

"$Budgetd": 62.5,

"$Agile": "No",

"$PoolTaskAssignment": "",

"$Forecastd": 0,

"last_modified": "02/09/2018",

"last_modified_by": "** Global Configurator",

"$Region": "3.Japan",

"rel_dataobject_id": 1080,

"$_$ProjectManager": "",

"$Forecastk": 800,

"$ExpBenefits": 700,

"dataobject_parent_id": 1025,

"$FinProgress": 50,

"$Progress": "010",

"$Probability": "",

"$Actualsd": 50,

"$Score": 7.4,

"$Weightedscore": 0,

"object_id": 82,

"$Tech": "2.In Progress",

"$Actualsk": 350,

"$ActivityType": "1. Corporate Projects",

"$StrategicImpact": "Medium",

"attr_dataobject_id": 1080,

"dataobject_parent_name": "IT Portfolio",

"currency_name": "Euro",

"object_name": "Project",

"$Status": "Correct",

"$complete": 15,

"$Risk": "2.In Progress",

"$ImpactBusStrategy": "High",

"$StartDate": "07/01/2017",

"$_$FinancialController": ""

}

]

"description": "GET_DATAOBJECTS#$#3,0.075",

"id": 0,

"ret_count": 0,

"i18NParams": [],

"i18NMessageId": ""

}

Reporting Web Service has a default rows limitation (1000 rows) to avoid performance issues.

It is configurable parameter but you can also rethink your approach to do more request and getting smaller set of data.

6.2 Data Export (with data definition)

To export data from Triskell you need to use the reporting web service.

It's a proxied service (Please read documentation above). It requires previous standard authentication, using the login web service.

We are going to describe an example showing how to use this reporting service to extract data from Triskell easily.

First, you need to build a stored selector in Triskell and add it to a report. You can only assign one stored selector to your report.

In this example, we are going to extract timesheet data for a given user between 2 dates.

First, we need to create the parameters on Triskell reporting module:

We need these parameter ids to add to our web service request so we need to display Id column:

Then we create a stored selector using these parameters:

This is the query we use to build the stored selector:

select dataobject_name, startdate, hours

from tenant_vw_TIMESHEET

where user_name = ##USER_NAME##

and startdate >= ##FROM_DATE##

and enddate <= ##TO_DATE##

Then we need to create the report:

We need to get the report id to run the report from a web service, so display the id column:

URL	URL: https:// SERVER /triskell/service/rest/proxy/operation/execute/ReportService/GetReportDataToPanel
HTTP Method	POST
Content-Type Header	application/json
URL Parameters	JSON format

JSON request example:

{

'id': 0,

'params': {

"REPORTID":"15",

"valuesByParams":"9#System Administrator##10#2015.10.5##11#2015.10.11"

} ,

'objects': null

}

Field description:

id: 0. It's required but not used for this service.
objects: null. It's required but not used for this service.
params:
- REPORTID: Required. It's your report Id taken from Triskell.
- valuesByParams: Contains all report parameters. For each parameter the format is: {paramId}#{value}. You can concatenate several report params using "##" separator.

Example of JSON result:

{

"authash": "dd06d7c94cd9a73f62b45c5b54247bce",

"executime": 181231719,

"success": true,

"messages": [],

"message": null,

"resultType": 1,

"data": {

"ReportingStoredSelector": {

"isTruncatedResult": false,

"res": [

{

"startdate": "10/05/2015",

"hours": 2,

"dataobject_name": "Integración de los componentes"

{

"startdate": "10/06/2015",

"hours": 2,

"dataobject_name": "Create new Risk"

}

"columns": [

{

"text": "dataobject_name",

"dataIndex": "dataobject_name",

"type": "string",

"filter": {

"type": "string"

}

{

"text": "startdate",

"xtype": "datecolumn",

"dataIndex": "startdate",

"format": "Ext.Date.defaultFormat",

"filter": {

"type": "date"

}

{

"text": "hours",

"dataIndex": "hours",

"type": "float",

"filter": {

"type": "numeric"

}

"fields": [

{

"name": "dataobject_name",

"type": "string"

{

"name": "startdate",

"type": "date"

{

"name": "hours",

"type": "float"

}

]

}

"id": 0,

"i18NMessageId": "",

"i18NParams": []

}

Reporting Web Service has a default rows limitation (1000 rows) to avoid performance issues.

It is configurable parameter but you can also rethink your approach to do more request and getting smaller set of data.

6.3 Advanced Lifecycle

It's a proxied service (Please read documentation above). It requires previous standard authentication, using the login web service.

We are going to describe an example showing how to use this service to transition a dataobject from the current state to a new one.

First, you need to build a stored selector and a report in Triskell to obtain the dataobject and stage ids, as described in the previous section 6.1 Data Export.

URL	https://SERVER/triskell/service/rest/proxy/operation/execute/ObjectPropertiesPanelAS/AdvancedLifecycleChange
HTTP Method	POST
Content-Type Header	application/json
URL Parameters	JSON format

JSON request example:

{

"objects":"",

"params": {

"dataObjectId":"1064",

"newLifecycle":"62",

"commentToTransition":"Text on commentToTransition",

"attachmentsToTransition":"Text on attachmentsToTransition"

"id":0

}

Field description:

id: 0. It's required but not used for this service.
objects: null. It's required but not used for this service.
params:
- dataObjectId: Required. It's your dataobject Id taken from Triskell.
- newLifecycle: Required. It's the new state on your dataobject Id taken from Triskell.
- commentToTransition: Comment about the transition.
- attachmentsToTransition: Text to attach to the transition.

Example of successful JSON result:

{

"authash": "03663e556a63170e8fe3b40667f6e09f",

"executime": 233380846,

"success": true,

"messages": [],

"message": null,

"resultType": 1,

"i18NMessageId": "",

"i18NParams": []

}

Example of error JSON result:

{

"authash": "03663e556a63170e8fe3b40667f6e09f",

"executime": 0,

"success": false,

"messages": [],

"message": "Transition to stage 2.Analysis not allowed",

"resultType": 3,

"i18NMessageId": "",

"i18NParams": []

}

7 Swagger UI for newer REST APIs

The latest REST APIs are available in Swagger pages.

Swagger acts as a documentation for these new REST APIs, and you can experiment directly on this page by calling these REST APIs. Please note that any operations conducted on this page are actually performed on Triskell System, so exert due caution, especially if you have a Configuration license.

There are 3 Swagger pages that you can access:

<TRISKELL_SERVER_URL>/triskell/api/rest/swagger-ui.html : List all REST APIs.
<TRISKELL_SERVER_URL>/triskell/api/rest-configurators/swagger-ui.html : List REST APIs that can only be accessed by a Configurator user.
<TRISKELL_SERVER_URL>/triskell/api/rest-endusers/swagger-ui.html : List REST APIs that can be accessed by an end-user, i.e. a user without Configurator access.

If some of your Triskell “power” end-users want to build their own integration with Triskell, you can share the “rest-endusers” Swagger page to them – this will ensure that they will only view the REST APIs that they can actually use.

Note that all APIs described in the swagger available at /api/rest-configurators/* and /api/rest-users/* can also be called at the url /api/rest/*. These two user-specific Swagger pages are only here for informative purposes.

All these new REST APIs are only supporting JSon – no XML support is provided at this point, and we do not plan to provide any in the future.

Note that many of the “legacy” REST APIs documented earlier in this document do not have an alternative in the Swagger-enabled REST APIs, but we will port the most often used existing Triskell REST APIs to Swagger in the future as well as provide entirely new use cases.

Related to

3.2 Login Service

3.2.4 API Key for Stateful login

3.3 Logout Service

4.2.1.1 Fields description

4.2.1.1.1 Mandatory fields

4.2.1.1.2 Optional fields

4.2.1.2 User Creation example

4.3.1.1 Fields description

4.3.1.1.1 Mandatory fields

4.3.1.1.2 Optional fields

4.3.2.1 Fields description

4.3.2.1.1 Mandatory fields

4.3.2.1.2 Optional fields

Related articles