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

Error rendering macro 'rw-search'

null

Versions Compared

Key

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

...

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.

Anchor
adminSchedule
adminSchedule

Expand
titleAdministrationSchedule
ParameterData TypeDescription

Frequency

ScheduleFrequency[]An array containing schedule frequency objects.
NextRunDateTimeGMTString 
ScheduleActiveString 
ScheduleDescriptionString 
ScheduleUUIDStringThe unique universal identifier of the schedule.

Anchor
scheduleFrequency
scheduleFrequency

Expand
titleScheduleFrequency
ParameterData TypeDescription

FrequencyCode

String 
FrequencyUnitInteger 
LocalRunTimeInteger 
LocalTimezoneCodeStringLocal time zone.