Administration Object Definitions

UserId

String

User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method.

Password

String

Password of the Yellowfin user.

FirstName

String

First name of of the Yellowfin user.

LastName

String

Last name of of the Yellowfin user.

Initial

String

Middle initial of the Yellowfin user.

SalutationCode

String

Title of the Yellowfin user. Possible values include:

• DR
• MISS
• MR
• MRS
• MS

RoleCode

String

Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator).

EmailAddress

String

Email address of the Yellowfin user.

LanguageCode

String

Two letter code for the preferred language.

IpId

Integer

Internal Yellowfin IP ID.

TimeZoneCode

String

The TimeZoneCode of the Yellowfin user.

Status

User status. One of

• ACTIVE
• INACTIVE
• INACTIVEWITHEMAIL

ReportName

String

ReportDescription

String

ReportId

Integer

ExecutionObject

String

ReportCategory

String

ReportSubCategory

String

BirtData

String

SourceName

String

SourceId

Integer

AuthoringMode

String

ReportTemplate

String

DataOutput

String

DashboardEnabled

Boolean

ViewId

Integer

ViewName

String

ViewDescription

String

LastModifierName

String

LastModifierId

Integer

LastModifiedDate

Date

PublishDate

Date

DeliveryMode

String

LastRunTime

Integer

AverageRunTime

Integer

RoleCode

String

ChartTypeCode

String

Usage

Integer

ReportGroupName

String

ReportGroupDescription

String

ReportGroupId

Integer

ReportGroupStatus

String

ReportGroupType

String

ReportGroupInternalReference

String

GroupReports

Array (AdministrationReports)

Array of AdministrationReport objects which hold report metadata. These are the reports that make up the portlets within the dashboard tab

AssociatedReports

Array (Integer)

RoleName

String

The name of the Yellowfin Role

RoleDescription

String

The business description of the Yellowfin Role

RoleCode

String

The internal code for the Yellowfin Role that is generated and referenced in the database

GroupName

String

GroupDescription

String

GroupId

Integer

GroupStatus

String

GroupInternalReference

String

GroupMembers

Array (AdministrationGroupMember)

An array of AdministrationGroupMember objects. These objects hold group member metadata

ClientName

String

Name of the client organisation

ClientReferenceID

String

Client Reference ID which is the unique ID used to identify a client

TimeZoneCode

String

A client organisation’s local time zone code. See appendix for valid values.

DefaultOrg

Boolean

Boolean value that returns true if this organisation is the primary organisation

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

ResourceName

String

ResourceDescription

String

ResourceId

Integer

ResourceUUID

Integer

ResourceType

String

ResourceOrgId

Integer

ResourceCode

String

ItemIndex

Integer

The index of the item that this option is attached too.

OptionKey

String

The type of option.

OptionValue

String

A value associated with this option.

True

False

Replace an existing item with an item from the import file.

Note: this requires an existing record to be replaced.

Override the details of a data source password during import.

Note: this requires PASSWORD2 to be set as well.

True

False