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

Versions Compared

Key

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

...

Expand
titleADDCOLUMNTOVIEW

This web service call adds a new database column to the specified view, using the naming and category provided in an AdminsitrationViewField object.


Request Parameters

The following parameters should be passed with this request:

Request Element

Data Type

Description

LoginId

String

An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method.

This account must have the “web services” role enabled, and must belong to the default (i.e. primary) org.

Password

String

Password of the above account.

OrgId

Integer

Default (i.e. primary) organization ID within Yellowfin. Always set this to 1.

OrgRef

String

Optional. Client organization the view can be found in.

Function

String

Web service function. Set this to "ADDCOLUMNTOVIEW".

ViewId

Integer

Internal ID of the view to be edited.

Parameters

String []

String array containing the database table and column name to be added. For example, the column “first_name” in the “person” table: {“person”,”first_name”}.

Field

AdministrationViewField

Object containing the new column definitions. See table below.

 

The following are required parameters to the AdministrationViewField object.

Object Element

Data Type

Description

ShortDescription

String

Primary name of the column to be added as seen in the view builder.

LongDescription

String

Description of the column to be added.

FieldCategory

String

Category the newly created field will be placed under. For e.g. “DIMENSION” or “METRIC”.


Request Example

Below is a SOAP JAX example for this request:

Code Block
languagexml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
          <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>ADDCOLUMNTOVIEW</function>
            <viewId>60543</viewId>
            <parameters>person</parameters>
            <parameters>first_name</parameters>
            <field>
            	<shortDescription>Person Name</shortDescription>
            	<longDescription>This is the name this person wants to be called</longDescription>
            	<fieldCategory>People</fieldCategory>
            </field>       
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 

 

Response Parameters

The returned response will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

  • SUCCESS
  • FAILURE

 

Response Example

The service will return the below response, according to our SOAP example:

Code Block
languagexml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>50b03dd1649bbb123605aa801829095b</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

 


 

...