レポートオブジェクト定義

CommentId

Integer

コメントのIDです。

getCommentId()

AuthorId

Integer

コメント作成者のIDです。

getAuthorId()

Comment

String

コメントの値です。

getComment()

ReportId

Integer

コメントが追加されているレポートのIDです。

getReportId()

ParentCommentId

Integer

関連付けられているコメントの主要IDです。これは、ある特定のコメントが、親コメントへの返信である場合に適用されます。

getParentCommentId()

StatusCode

String

コメントのステータスです。

getStatusCode()

CommentDate

DateTime

コメントが作成された日付と時間の値です。

getCommentDate()

LastActivityDate

DateTime

特定のコメントが最後に更新された日付と時間の値です。

getLastActivityDate()

DataValue

String[]

レポート結果セットの各カラムのデータを含む文字列の配列です。

getDataValue()

ReportIndex

Integer

配信された埋め込みHTML内のイメージのインデックスです。

getReportIndex()

Content Type

String

このグラフのMIMEコンテンツタイプです。値の選択肢は、以下の通りです。

• 「image/png」
• 「image/jpg」

getContentType()

Data

String

Base64のバイナリーイメージデータです。

getData()

Filename

String

HTMLに埋め込まれているファイルの名前です。

getFilename()

ColumnName

String

レポートのカラム（列）名です。

getColumnName()

DisplayName

String

カラム（列）の表示名です。

getDisplayName()

ColumnLength

String

レポートカラム（列）の長さです。

getColumnLength()

Integer

カラム（列）のフィールドIDです。

getFieldId()

DataType

String

カラム（列）のデータ型です。

getDataType()

Hidden

Boolean

カラム（列）のレポートへの表示有無です。

getHidden()

Prompt

Boolean

フィルターのみの設定です。カラム（列）のプロンプトフィールド有無です。

getPrompt()

FilterId

String

フィルターのみの設定です。カラム（列）がフィルターの場合の、フィルターIDです。

getFilterId()

FilterType

String

フィルターのみの設定です。フィルタータイプと、プロンプトに設定が必要なデータを決定します。

getFilterType()

DefaultValue1

String

フィルターのみの設定です。設定されている場合の、フィルターの最初のデフォルト値です。

getDefaultValue1()

DefaultValue2

String

フィルターのみの設定です。設定されている場合の、フィルターの二番目のデフォルト値です。

getDefaultValue2()

MinimumValue

BigDecimal

フィルターのみの設定です。設定されている場合の、フィルターの最小値です。

getMinimumValue()

MaximumValue

BigDecimal

フィルターのみの設定です。設定されている場合の、フィルターの最大値です。

getMaximumValue()

ContentType

String

MIMEコンテンツタイプです。

getContentType()

Data

String

Base64バイナリーデータです。

getData()

Key

String

ReportBinaryObjectオブジェクトのキーです。

getKey()

Actual

String

KPIメトリック（数値）の実績値です。

getActual()

Target

String

KPIメトリック（数値）の目標値です。

getTarget()

Variance

String

KPIメトリック（数値）の差異値です。

getVariance()

ParentCategory

String

親カテゴリー値です。

getParentCategory()

Targets

Array（String）

特定の親カテゴリーの目標である文字列値の配列です。

getTargets()

Recipient

Integer

購読の受信者のIDです。

getRecipient()

Subject

String

購読の件名です。

getSubject()

BodyText

String

購読のメッセージです。

getBodyText()

FrequencyTypeCode

String

購読の頻度です。値の選択肢は、以下の通りです。

• MINUTES
• DAILY
• WEEKLY
• FORTNIGHTLY
• MONTHLY
• QUARTERLY
• BIANNUAL
• ANNUAL
• ENDOFMONTH

getFrequencyTypeCode()

FrequencyCode

String

getFrequencyCode()

FrequencyUnit

Integer

スケジュールを実行する月の曜日を表す頻度単位です。選択された月の許容値内でなければいけません（そのため、2月31日などの設定はできません）。

getFrequencyUnit()

Format

String

購読ファイルタイプです。値の選択肢は、以下の通りです。

• PDF
• HTML
• CSV
• DOC
• XLS
• RTF

getFormat()

ConditionList

Array（Condition）

配信ルールを保存するConditionオブジェクトの配列です（レポートオブジェクト定義#Conditionを参照してください）。

getConditionList()

AdvancedTimezoneCode

String

購読が行われる地域のタイムゾーンです。

getAdvancedTimezoneCode()

AdvancedTime

Integer

購読の現地実行時間です。

getAdvancedTime()

Operator

String

カラム（列）のフィルター演算子です。値の選択肢は、以下の通りです。

• BETWEEN
• NOTBETWEEN
• EQUAL
• NOTEQUAL
• GREATER
• GREATEREQUAL
• INLIST
• NOTINLIST
• ISNULL
• ISNOTNULL
• LESS
• LESSEQUAL
• STARTSWITH
• NOTSTARTSWITH
• CONTAINS
• NOTCONTAINS
• ENDSWITH
• NOTENDSWITH

getOperator()

FieldId

Integer

カラム（列）のフィールドIDです。

getFieldId()

Value1

String

最初の条件値です。

getValue1()

Value2

String

二番目の条件値です。演算子が、「の間（〜）（BETWEEN）」や「の間でない（NOTBETWEEN）」などの場合に必要です。

getValue2()

TabId

Integer

ダッシュボードタブのIDです。

getTabId()

GroupTypeCode

String

ダッシュボードタブのタイプです。値の選択肢は、以下の通りです。

• ANALYTIC
• KPI
• STANDARD

getGroupTypeCode()

Owner

Integer

ダッシュボード所有者のIDです。

getOwner()

OwnerTypeCode

String

ダッシュボード所有者のタイプです。デフォルトでは、ORGANISATIONに設定されています。

getOwnerTypeCode()

AccessCode

String

ダッシュボードタブのセキュリティレベルです。

getAccessCode()

StartDate

Date

作成日です。

getStartDate()

EndDate

Date

該当する場合の、終了日です。

getEndDate()

StatusCode

String

ダッシュボードタブのステータスです。

getStatusCode()

ShortDescription

String

ダッシュボードタブの名前です。

getShortDescription()

LongDescription

String

ダッシュボードタブの説明です。

getLongDescription()

LanguageCode

String

二文字の言語コードです。

getLanguageCode()

StyleCode

String

レイアウトコードです。値の選択肢は、以下の通りです。

• SINGLE
• TWO
• THREE
• WIDENARROW
• NARROWWIDE

getStyleCode()

Audience

String

対象者の説明です。

getAudience()

ParentGroupId

Integer

ダッシュボードタブがドラフト（編集中）モードの場合、元のタブIDは、こちらのカラム（列）に保存されます。

getParentGroupId()

Elements

Array (DashboardElement)

ダッシュボードタブ内に存在するレポートのポートレット情報を含むDashboardElementオブジェクトです（レポートオブジェクト定義#DashboardElementを参照してください）。

getElements()

Filters

Array (DashboardFilterDefinition)

ダッシュボードタブ、分析フィルター、フィルターグループに関する書式レコードを含むDashboardFilterDefinitionオブジェクトです（レポートオブジェクト定義#DashboardFilterDefinitionを参照してください）。

getFilters()

Fields

Array (DashboardFieldDefinition)

ダッシュボードタブにドリルダウンとして表示されるフィールドに関する書式レコードを含むDashboardFieldDefinitionオブジェクトです。

getFields()

TabId

Integer

ダッシュボードタブのIDです。

getTabId()

EntityId

Integer

ポートレットのIDです。これは、レポートIDである場合もあります。

getEntityId()

EntityTypeCode

String

ポートレットのエンティティタイプです。デフォルトでは、REPORTに設定されています。

getEntityTypeCode()

ColumnNumber

Integer

カラム（列）方向でのポートレットの位置を示します。最初のカラム（列）は、値1から始まります。

getColumnNumber()

RowNumber

Integer

ロウ（行）方向でのポートレットの位置を示します。最初のロウ（行）は、値1から始まります。

getRowNumber()

SequenceNumber

Integer

ダッシュボードタブ内のポートレットの読み込み順序です。

getSequenceNumber()

StartDate

Date

ポートレットが追加された日付です。

getStartDate()

PortletStatus

String

ポートレットのステータスです。

getPortletStatus()

PortletHeight

Integer

ポートレットの高さをピクセル単位で示します。

getPortletHeight()

TabId

Integer

ダッシュボードタブのIDです。

getTabId()

FieldId

Integer

カラム（列）のフィールドIDです。

getFieldId()

FieldType

String

フィールドのデータ型です。値の選択肢は、以下の通りです。

• BOOLEAN
• DATE
• GISGEOMETRY
• GISMULTIPOLY
• GISPOINT
• NUMERIC
• TEXT
• TIMESTAMP

getFieldType()

ReportId

Integer

レポートのIDです。

getReportId()

TemplateId

Integer

対応するフィールドテンプレートレコードのIDです。

getTemplateId()

FieldName

String

カラム（列）名です。

getFieldName()

FieldDescription

String

カラム（列）名です。

getFieldDescription()

GroupId

Integer

ダッシュボードタブのIDです。

getGroupId()

ComponentId

Integer

コンポーネントタイプに基づくコンポーネントの数値IDです。

getComponentId()

ComponentTypeCode

String

DashboardFilterDefinitionオブジェクトのコンポーネントタイプは、以下の通りです。

• FILTER（個別の分析フィルター）
• FILTERGROUP（分析フィルターグループ）
• NULL（一般的なダッシュボードタブ）

getComponentTypeCode()

EntityId

Integer

getEntityId()

EntityTypeCode

String

DashboardFilterDefinitionオブジェクトのエンティティタイプは、以下の通りです。

• REPORT（分析フィルター）
• REPORTGROUP（一般的なダッシュボードタブ）

getEntityTypeCode()

FormatKey

String

書式コードです。

getFormatKey()

FormatValue

String

書式値です。

getFormatValue()

FilterId

Integer

フィルターのIDです。

getFilterId()

IsOmitted

Boolean

デフォルトでのフィルターを省略有無です。

getIsOmitted()

DataValue

String

特定のフィルターのフィルター値です。値が2つある場合（例：フィルター演算子が、「の間（〜）（BETWEEN）」の場合）は、値はパイプ値で連結されます。

getDataValue()

ReportId

Integer

フィルターが属するレポートのIDです。

getReportId()

FilterType

String

フィルター演算子です。

getFilterType()

FilterId

Integer

フィルターのIDです。

getFilterId()

TabId

Integer

レポートがあるダッシュボードタブのIDです。

getTabId()

FilterValue

String

特定のフィルターのフィルター値です。フィルター演算子が、2つの値を必要とする場合（例：フィルター演算子が、「の間（〜）（BETWEEN）」の場合）、値はパイプ値で連結されます。

getFilterValue()

TemplateId

Integer

フィールドテンプレートレコードのIDです。これは、フィルタータイプが、DRILLなどの場合に適用されます。

getTemplateId()