ルールの取得
get
/essbase/rest/v1/utils/rules
ファイル・カタログ・パスからルール・ファイルを取得します。
要求
問合せパラメータ
- path(optional): string
カタログ・パス。
レスポンス
サポートされるメディア・タイプ
- application/json
- application/xml
200 レスポンス
OK
ルール・ファイルが正常に返されました。 レスポンス・タイプは、Acceptヘッダーに応じてJSON、XMLまたはJSONストリームのいずれかになります。 Accept='application/json'
またはAccept='application/xml'
の場合、ルールはレスポンス本文に返されます。 Accept='application/octet-stream'
の場合、ルールはJSONストリームとして返されます。
ルート・スキーマ : ルール
タイプ:
Show Source
object
- bibpm(optional): boolean
- columnOperations(optional): array columnOperations
- dataLoadOptions(optional): object DataLoadOptions
- dataSource(optional): object DataSource
- dimensionBuildOptions(optional): object DimBuildOptions
- dimensions(optional): array dimensions
- editorOptions(optional): object EditorOptions
- encoding(optional): string
許可される値:
[ "NONE", "NONUNICODE", "UTF8" ]
- essbaseInfo(optional): object EssbaseInfo
- fields(optional): array fields
- flatFileBased(optional): boolean
- locale(optional): string
- name(optional): string
- studio(optional): boolean
- timeStamp(optional): integer(int64)
- xolap(optional): boolean
ネストされたスキーマ : DataLoadOptions
タイプ:
Show Source
object
- clearCombinations(optional): array clearCombinations
- option(optional): string
許可される値:
[ "NONE", "OVERWRITE", "ADD", "SUBTRACT" ]
- removeAll(optional): integer(int32)
- signFlipDimension(optional): string
- signFlipUDA(optional): string
ネストされたスキーマ : EditorOptions
タイプ:
Show Source
object
- application(optional): string
- database(optional): string
- dataFile(optional): string
- dataFileApplication(optional): string
- dataFileDatabase(optional): string
- dataFileServer(optional): string
- dataFileType(optional): string
許可される値:
[ "NONE", "EXCEL", "LOTUS2", "LOTUS3", "LOTUS4", "TEXT" ]
- object(optional): string
- server(optional): string
- startRecord(optional): integer(int32)
- viewCount(optional): integer(int32)
- viewGridLines(optional): boolean
- viewIgnored(optional): boolean
- viewMode(optional): string
許可される値:
[ "DIMBUILD", "DATALOAD" ]
- viewRawData(optional): boolean
- viewToolbar(optional): boolean
ネストされたスキーマ : ColumnOperation
タイプ:
Show Source
object
- position(optional): integer(int32)
- type(optional): string
許可される値:
[ "CREATE", "JOIN", "SPLIT", "MOVE", "CREATETEXT", "SUBSTRING" ]
- updateColumns(optional): boolean
ネストされたスキーマ : Dimension
タイプ:
Show Source
object
- added(optional): boolean
- addMemberOption(optional): string
許可される値:
[ "GENERATION", "SIBLING_LOWEST_LEVEL", "CHILD", "SIBLING_MATCHING_STRING", "LEVEL", "PARENT_CHILD", "GEN_NULLS", "LEVEL_NULLS" ]
- aggregateLevelUsage(optional): integer(int32)
- allowassociationChanges(optional): boolean
- allowFormulaChanges(optional): boolean
- allowMoves(optional): string
許可される値:
[ "NOTOK", "OK", "IGNORE", "GEN2", "NOTGEN2" ]
- allowPropertyChanges(optional): boolean
- allowUDAChanges(optional): boolean
- attributeOptions(optional): object AttributeOptions
- autoFixSharedMember(optional): boolean
- configOption(optional): string
許可される値:
[ "EXISTING", "DENSE", "SPARSE" ]
- createAttributeMembers(optional): boolean
- dimensionSolveOrder(optional): integer(int32)
- flexible(optional): boolean
- generations(optional): array generations
- hierarchyType(optional): string
許可される値:
[ "EXISTING", "MULTIPLE", "STORED", "DYNAMIC" ]
- incrementalSort(optional): boolean
- levels(optional): array levels
- measureOptions(optional): object MeasureOptions
- memberName(optional): string
- name(optional): string
- share(optional): boolean
- solveOrder(optional): integer(int32)
- sortOption(optional): string
許可される値:
[ "NONE", "ASCENDING", "DESCENDING" ]
- storageType(optional): string
許可される値:
[ "EXISTING", "STORE", "NEVER_SHARE", "LABEL_ONLY", "DYNAMIC_CALC_STORE", "DYNAMIC_CALC" ]
- type(optional): string
許可される値:
[ "EXISTING", "NONE", "ACCOUNTS", "TIME", "COUNTRY", "ATTRIBUTES" ]
- unique(optional): string
許可される値:
[ "EXISTING", "UNIQUE", "DUPLICATE", "NONE" ]
- updateOption(optional): string
許可される値:
[ "MERGE", "REMOVE_UNSPECIFIED" ]
ネストされたスキーマ : AttributeOptions
タイプ:
Show Source
object
- baseDimension(optional): string
- indepDimensions(optional): array indepDimensions
- modified(optional): boolean
- scaassociationMode(optional): string
許可される値:
[ "NOOVERWRITE", "OVERWRITE" ]
- scadisAssociationMode(optional): string
許可される値:
[ "NOOVERWRITE", "OVERWRITE", "EXTEND" ]
- type(optional): string
許可される値:
[ "NUMERIC", "BOOLEAN", "TEXT", "DATE", "EXISTING" ]
ネストされたスキーマ : MeasureOptions
タイプ:
Show Source
object
- currencyCategory(optional): string
- currencyConversion(optional): string
許可される値:
[ "EXISTING", "NONE", "CATEGORY", "NO_CONVERSION" ]
- currencyName(optional): string
- skip(optional): string
許可される値:
[ "NONE", "NA", "MISSING", "ZERO", "MISSING_ZERO" ]
- timeBalanceOption(optional): string
許可される値:
[ "EXISTING", "NONE", "FIRST", "LAST", "AVERAGE" ]
- twoPass(optional): boolean
- varianceReporting(optional): string
許可される値:
[ "EXISTING", "NON_EXPENSE", "EXPENSE" ]
ネストされたスキーマ : IndepDimension
タイプ:
Show Source
object
- name(optional): string
- type(optional): string
許可される値:
[ "CONTINUOUS", "DISCRETE" ]
ネストされたスキーマ : Field
タイプ:
Show Source
object
- case(optional): string
許可される値:
[ "NOOP", "LOWER_CASE", "UPPER_CASE", "FIRST_CAPITAL_CASE" ]
- convertSpaceToUnderScore(optional): boolean
- dataloadOptions(optional): object FieldDataLoadOptions
- dateFormat(optional): string
- dimensionBuildOptions(optional): object FieldDimBuildOptions
- name(optional): string
- option(optional): string(byte)
- prefix(optional): string
- rejectFilterJoinOption(optional): string
許可される値:
[ "AND", "OR" ]
- rejectFilters(optional): array rejectFilters
- replaceInformation(optional): array replaceInformation
- selectFilterJoinOption(optional): string
許可される値:
[ "AND", "OR" ]
- selectFilters(optional): array selectFilters
- smartList(optional): string
- suffix(optional): string
- transform(optional): object Transform
- trim(optional): boolean
- width(optional): number(double)
ネストされたスキーマ : FieldDataLoadOptions
タイプ:
Show Source
object
- data(optional): boolean
- ignore(optional): boolean
- referDimension(optional): string
- referNumber(optional): integer(int32)
- referOption(optional): integer(int32)
- scale(optional): boolean
- scalingfactor(optional): number(double)
- storeType(optional): string
許可される値:
[ "MIN", "MAX", "AVG", "SUM", "COUNT" ]
- storeTypeCountMissing(optional): boolean
- useReference(optional): boolean
ネストされたスキーマ : FieldDimBuildOptions
タイプ:
Show Source
object
- alias(optional): string
- attributeBuildProperties(optional): object AttributeBuildProperties
- attributeDimension(optional): string
- dimension(optional): string
- endIndepColumns(optional): array endIndepColumns
- generation(optional): integer(int32)
- generationProperty(optional): string
許可される値:
[ "NONE", "CONSOLIDATIONTYPE", "STORAGETYPE", "TIMEBALANCE", "SKIP", "VARIANCEREPORT", "TWOPASSCALC", "HIERARCHYTYPE" ]
- generationType(optional): string
許可される値:
[ "NONE", "PARENT", "CHILD", "GENERATION", "LEVEL", "ATTRIBUTE_MEMBER", "ALIAS", "PROPERTY", "FORMULA", "MEMBER_ID", "SOLVE_ORDER", "UDA", "DUPGEN", "DUPLEVEL", "DUPGEN_ALIAS", "DUPLEVEL_ALIAS", "CURRENCY_NAME", "CURRENCY_CATEGORY", "NUMTYPES", "ATTRIBUTE_DIM_LABEL", "ATTRIBUTE_PARENT", "DUPGEN_CAPTION", "DUPLEVEL_CAPTION", "AGGLEVELUSAGE", "ATTR_ASSOCIATE", "REFMEMBER", "GEN_RIGHTJOIN", "COMMENT", "SHARED_GEN", "GEN_NATUREJOIN", "GEN_LEFTJOIN", "GEN_OTLMBR", "COMMENT_EX", "REFMEMBERID", "SMARTLISTID", "SMARTLISTTEXT", "FORMATSTRING" ]
- ignore(optional): boolean
- parent(optional): integer(int32)
- refer(optional): integer(int32)
- referIndex(optional): integer(int32)
- shared(optional): integer(int32)
- startIndepColumns(optional): array startIndepColumns
- staticField(optional): boolean
ネストされたスキーマ : Transform
タイプ:
Show Source
object
- nodes(optional): array nodes
- type(optional): string
許可される値:
[ "COLUMN", "SUBSTR", "CONCAT", "STATICSTR", "IGNORE" ]
ネストされたスキーマ : フィルタ
タイプ:
Show Source
object
- caseSensitive(optional): boolean
- condition(optional): string
許可される値:
[ "EQUAL_TO", "NOT_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL_TO", "LESS_THAN", "LESS_THAN_EQUAL_TO", "CONTAIN", "DOES_NOT_CONTAIN" ]
- stringFilter(optional): boolean
- type(optional): string
許可される値:
[ "REJECT", "SELECT" ]
- value(optional): string
400 レスポンス
不正なリクエスト
ルール・ファイルのインポートに失敗しました。 カタログ・パス情報が正しくない可能性があります。
500 レスポンス
内部サーバー・エラー。