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

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 11

changes.mady.by.user user-3484a

Saved on

compared with

New Version 12

changes.mady.by.user user-3484a

Saved on

Key

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

...

Expand
titleAdministrationServiceRequest

 

This object defines the type of call being made to the web service.

 

Object parameters:

Parameter NameTypeDescription
sessionIdString 
loginIdStringThis refers to a Yellowfin account with the web services role enabled. Must be a Yellowfin default (primary) org user.
passwordStringThis refers to the password of the above account.
ntlmBoolean 
orgIdIntegerThis should always be 1, which signifies the default org ID.
loginSessionIdString 
orgRefString 
queryString 
reportIdInteger 
dashboardTabIdInteger 
functionStringThis refers to the type of the call.
personAdministrationPerson 
groupAdministrationGroup 
reportAdministrationReport 
clientAdministrationClientOrg 
reportGroupAdministrationReportGroup 
favouritePersonFavourite 
contentResourcesContentResource[] 
importOptionsImportOption[] 
roleAdministrationRole 
retrospectiveDaysInteger 
binaryDatabyte[] 
peopleAdministrationPerson[] 
datasourceAdministrationDataSource 
sourceClientLinkAdministrationDataSourceClientLink 
sourceIdInteger 
scheduleAdministrationSchedule 

 

All parameters have corresponding “get” and “set” methods. For instance:

Code Block
languagejava
AdministrationServiceRequest sr = new AdministrationServiceRequest();
sr.setSessionId(savedSessionID);

 

It is not necessary to define all the parameters; each web service call has a list of the required parameters. Unspecified parameters will have a null value by default.

There are, however, mandatory parameters for any request, listed below:

  • loginId
  • password
  • orgId
  • function

Other parameters will be required depending on the function value.

Each request must contain the web service user details, that is who can call Yellowfin web services. This must be an existing user with the “Web services” role enabled, and these details should be specified as loginId, password, orgId.

 

 

 

Anchor
AdminServiceResponse
AdminServiceResponse

...

Expand
titleAdministrationReport

AdministrationReport Element

Data Type

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

 

 

Anchor
AdminClientOrg
AdminClientOrg

Expand
titleAdministrationClientOrg

AdministrationClientOrg Element

Data Type

Description

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

 

 

...