Skip to content

Comments (Financial Workspace)

Financial Workspace Comments Exposure with RESTful APIs

CCH Tagetik exposes data related to comments and attachments.
STATUS SWAGGER
ACTIVE -
FORMAT ROOT ENDPOINT
REST / OpenAPI <api root>/dataentry/comments/v1

Authorization

In order to use the APIs, it is necessary to enable the option described above and to have the 0001836-System Reports: Comments and 0004151 - FW System Reports: Comments and Attachments functions enabled in the user's role.

Use

The URL relating to the root of data service is:

<api-root>/dataentry/comments/v1/database_id

The service provides a zipped folder containing a file named index.xslx showing:

  • Forms
  • Managed Dimensions
  • All dimensions in the system, filtered based on the caller's user rights.
  • If it is filtered by a node, all comments on its children are displayed. If one of these children is in turn a node, comments on its children are displayed, and so on.
  • The dimensions' names are based on the application language of the caller.
  • The description of the dimensions' elements are in the description language selected by the caller.
  • The description of the Analytical Dimensions' elements on which the Personal data protection option is enabled will be exported encrypted.
  • Notes
  • In the case of multiple comments on the same report, the rows, equal to the first one up to the Comment field, are repeated.
  • Attachment
  • Attachments are included in the zipped folder returned by the API.
  • The Attachment field displays the name of the file as a hyperlink to the relevant file.
  • In case of multiple comments on the same form, they will be entered in subsequent rows, with empty cells up to the Comment field.
  • In case multiple attachments have the same file name, the operating system differentiates them by default.
  • User
  • The last user that modified the comment or the attachment.
  • Date
  • The date of the last modification.

belonging to the Reporting Layer, related to the Processes.

Besides the Process, you can also specify filters related to each of these elements in the body of the call, as follows:

  • Processes

"process":

  • Filters based on data related to a specific Process
  • Managed Dimensions

"":{

"values":[, ...],

"includeNullValues":

}

  • Filters based on the values of a specific dimension. The dimensions by which you can filter are:
  • Scenarios
  • Period
  • Entity
  • Accounts
  • Variation & Detail types
  • Category
  • Custom dimension 1 to 5
  • Unit
  • CTP entity
  • CTP custom dimension 2
  • Cod_Prospetto

  • Null (optional)

  • "includeNullValues":

    • Includes the empty fields for that dimension (false by default)

Examples of direct calls to the service

API's filters are inserted in the request's body, thus the only difference in t he URL is the reference DB

  • Example of URL: http://qa7:8280/tagetikcpm/api/dataentry/comments/v1/TGK_QC_TRUNK_INCUBATEAM

All comments

  • Parameters: none
  • Body:
  • {
  • }
  • Data are read unfiltered.

Comments belonging to the ACT process

  • Parameters: Process
  • Body:
  • {

"process":"ACT"

}

Comments belonging to Scenario "2017ACT_V1"

  • Parameters: Scenario
  • Body:
  • {

"scenario":{

"values":["2017ACT_V1"]

}

}

Comments belonging to scenarios "2017ACT_V1", "2018ACT_V1" and to account "65030"

  • Parameters: Scenario, Account
  • Body:
  • {

"scenario":{

"values":["2017ACT_V1","2018ACT_V1"]

},

"account":{

"values":["65030"]

}

}