Like what you see? Have a play with our trial version.

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 18

changes.mady.by.user user-3484a

Saved on

compared with

New Version 19

changes.mady.by.user user-3484a

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Following These objects are the object specific to the Administration web services:

...

Expand
titleAdministrationReportGroup

AdministrationReportGroup Element

Data Type

Description

ReportGroupName

String 
ReportGroupDescriptionString 
ReportGroupIdInteger 
ReportGroupStatusString 
ReportGroupTypeString

One of the following values:

  • ANALYTIC
  • KPI
ReportGroupInternalReferenceString 
GroupReportsAdministrationReport[]An array contain details of the dashboard's reports.
AssociatedReportsInteger[]An array of Associated Reports IDs.
PublishUUIDStringDashboard UUID

 

 

Anchor
reportBinaryObject
reportBinaryObject

Expand
titleReportBinaryObject

ReportBinaryObject Element

Data Type

Description

Key

String

Unique key used for Binary Object storage

ContentType

String

MIME type for the Binary Object

Data

Array (Byte)

Raw data for Binary Object

 

 

...

Expand
titleParentDashboard
ParameterData TypeDescription

dashboardName

String

Name of the dashboard.

dashboardGroupId

Integer

 

tabIds

String[]

An array of the sub tabs' IDs.

tabNames

String[]

An array of the sub tabs' names.

statusCodes

String[]

An array of the sub tabs status.

Anchor
personFavourite
personFavourite

Expand
titlePersonFavourite
ParameterData TypeDescription

PersonId

Integer

User IpId (Yellowfin database, Person.IpPerson)

ContentType

String

This optional parameter can be set to filter the result by a specific content type. Values could include:

  • REPORT
  • REPORTGROUP
  • DISCUSSIONGROUP
  • REPORTVIEW
  • STORYBOARD
  • IMAGE

ContentId

Integer

This optional parameter can be used to restrict the result to a specific content by providing its internal ID.

FavouriteType

String

 

CreationCode

String

 

CreatorId

Integer

This refers to the distributor of the content, who distributes the content to a user. This is used with the CreationCode set to “DISTRIBUTE”.

TextEntityId

Integer

 

InstanceId

Integer

 

CreationDate

Date

 

Subject

String

 

Message

String

 

WidthCode

String

 

 

Below are some possible combinations of ContentType, FavouriteType and CreationCode:

ContentTypeFavouriteTypeCreationCodeDescription

REPORT

FAVOURITE

MANUAL

Favorite reports.

REPORTGROUP

REPORTDASHBOARD

 

All user dashboard tabs that a user can see on a dashboard.

REPORTGROUP

INBOX

DISTRIBUTE

Dashboards distributed to the user.

DISCUSSIONGROUP

DISCUSSIONMEMBER

 

Discussions which a user is a member of.

REPORTVIEW

 

MANUAL

Favourite views.

STORYBOARD

FAVOURITE

WEB

Favourite storyboards.

IMAGE

PROFILE

MANUAL

User's profile image.

COMMENT

FLAGGED

MANUAL

Flagged by user comments.