Table Of Content

Version 11 Release 2 IBM Planning Analytics TM1 REST API IBM Note Before you use this information and the product it supports, read the information in Chapter 10, “Notices,” on page 167. Product Information This document applies to IBM Planning Analytics Version 2.0 and might also apply to subsequent releases. Licensed Materials - Property of IBM Last updated: 2019-01-20 © Copyright International Business Machines Corporation 2007, 2019. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents Introduction.........................................................................................................ix Chapter 1. Overview..............................................................................................1 Conformance................................................................................................................................................1 TM1 REST API introduction.........................................................................................................................2 Syntax used in examples........................................................................................................................2 Read from the model (HTTP GET)..........................................................................................................3 Create an entity (HTTP POST)................................................................................................................3 Update an entity (HTTP POST or PATCH)...............................................................................................4 Delete an entity (HTTP DELETE)............................................................................................................4 References...................................................................................................................................................5 Chapter 2. Installation and configuration............................................................... 7 Chapter 3. HTTP authentication.............................................................................9 Chapter 4. Metadata............................................................................................11 EDM hierarchy............................................................................................................................................11 EntityContainer: API..................................................................................................................................23 Entity types................................................................................................................................................24 Annotation............................................................................................................................................24 ApplicationContextFacet......................................................................................................................25 ApplicationContextFacetValue.............................................................................................................26 Attachment...........................................................................................................................................26 AttributeDefinition................................................................................................................................26 Cellset...................................................................................................................................................27 CellsetAxis............................................................................................................................................27 CellsetAxisTuple...................................................................................................................................28 CellsetCell.............................................................................................................................................28 Chore.....................................................................................................................................................30 ChoreReference....................................................................................................................................31 ChoreTask.............................................................................................................................................31 Configuration........................................................................................................................................31 Cube......................................................................................................................................................33 CubeDrillthrough..................................................................................................................................35 CubeReference.....................................................................................................................................35 Dimension.............................................................................................................................................35 DimensionReference............................................................................................................................36 Document.............................................................................................................................................36 DocumentReference............................................................................................................................37 Drillthrough...........................................................................................................................................37 Edge......................................................................................................................................................37 Element.................................................................................................................................................38 Entry......................................................................................................................................................39 ErrorLogFile..........................................................................................................................................40 Folder....................................................................................................................................................40 Group....................................................................................................................................................40 Hierarchy..............................................................................................................................................41 Level......................................................................................................................................................43 Link........................................................................................................................................................44 LocalizedAttributes..............................................................................................................................44 iii Logger...................................................................................................................................................44 MDXView...............................................................................................................................................45 Member.................................................................................................................................................45 MessageLogEntry.................................................................................................................................46 NativeView............................................................................................................................................47 Process.................................................................................................................................................48 ProcessDebugContext..........................................................................................................................49 ProcessDebugContextBreakpoint........................................................................................................50 ProcessDebugContextDataBreakpoint................................................................................................50 ProcessDebugContextLineBreakpoint.................................................................................................51 ProcessDebugContextLockBreakpoint................................................................................................51 ProcessDebugContextStackFrame......................................................................................................51 ProcessDebugContextVariable............................................................................................................52 ProcessErrorLog...................................................................................................................................52 ProcessReference.................................................................................................................................52 RelationalDrillthrough..........................................................................................................................53 SQLDataSource.....................................................................................................................................53 Sandbox................................................................................................................................................53 Server....................................................................................................................................................54 ServerSettings......................................................................................................................................55 Session..................................................................................................................................................55 Subset...................................................................................................................................................56 SubsetReference..................................................................................................................................57 Thread...................................................................................................................................................57 TransactionLogEntry............................................................................................................................58 TupleMember.......................................................................................................................................59 User.......................................................................................................................................................60 View......................................................................................................................................................61 ViewReference......................................................................................................................................62 Complex types...........................................................................................................................................62 AccessSettings.....................................................................................................................................62 AdministrationSettings.........................................................................................................................62 Attributes..............................................................................................................................................63 AuditLogSettings..................................................................................................................................63 AuthenticationSettings.........................................................................................................................64 CAMSettings.........................................................................................................................................64 CAPISettings.........................................................................................................................................64 CalculationComponent.........................................................................................................................65 CellDescriptor.......................................................................................................................................65 CellsetUpdate.......................................................................................................................................65 ChoreTaskParameter............................................................................................................................66 ClientSettings.......................................................................................................................................66 CubeUpdate..........................................................................................................................................66 DebugLogSettings................................................................................................................................66 DrillthroughRow....................................................................................................................................67 EventLogSettings..................................................................................................................................67 ExternalDatabaseSettings....................................................................................................................67 FedCellDescriptor.................................................................................................................................67 FeederTrace..........................................................................................................................................68 FileRetrySettings..................................................................................................................................68 HTTPSettings........................................................................................................................................68 JavaSettings.........................................................................................................................................68 JobQueuingSettings.............................................................................................................................68 LDAPSettings........................................................................................................................................69 LockingSettings....................................................................................................................................69 MTQSettings.........................................................................................................................................69 MemorySettings...................................................................................................................................70 ModellingSettings.................................................................................................................................70 iv NameValuePair.....................................................................................................................................70 NetworkSettings...................................................................................................................................71 PerformanceSettings............................................................................................................................71 ProcessDataSource..............................................................................................................................71 ProcessDebugContextObjectLock.......................................................................................................71 ProcessExecuteResult..........................................................................................................................72 ProcessParameter................................................................................................................................72 ProcessSyntaxError..............................................................................................................................72 ProcessVariable....................................................................................................................................73 RuleSyntaxError...................................................................................................................................73 RulesSettings........................................................................................................................................73 SSLSettings...........................................................................................................................................73 ServerLogSettings................................................................................................................................74 SpreadingSettings................................................................................................................................74 StargateSettings...................................................................................................................................74 StartupSettings.....................................................................................................................................75 SynchronizationSettings......................................................................................................................75 TISettings.............................................................................................................................................75 TM1WebSettings..................................................................................................................................75 ViewAxisSelection................................................................................................................................75 ViewCalculationSettings......................................................................................................................75 ViewTitle...............................................................................................................................................76 Enumerated types......................................................................................................................................76 AttributeType........................................................................................................................................76 CalculationType....................................................................................................................................76 CellStatus.............................................................................................................................................76 ChoreExecutionMode...........................................................................................................................76 ConflictResolution................................................................................................................................76 ElementType.........................................................................................................................................77 EncryptionFileType...............................................................................................................................77 FIPSMode.............................................................................................................................................77 IPVersion..............................................................................................................................................77 LogLevel................................................................................................................................................77 MemberType.........................................................................................................................................77 OracleErrorForceRowStatus................................................................................................................78 ProcessDebugContextHitMode............................................................................................................78 ProcessDebugContextLockMode.........................................................................................................78 ProcessDebugContextObjectLockScope.............................................................................................78 ProcessDebugContextStatus...............................................................................................................78 ProcessExecuteStatusCode.................................................................................................................78 ProcessProcedure................................................................................................................................79 ProcessVariableType............................................................................................................................79 SQLFetchType.......................................................................................................................................79 SecurityMode........................................................................................................................................79 ThreadType...........................................................................................................................................79 UpdateOrder.........................................................................................................................................79 UserType...............................................................................................................................................79 ViewConsolidationOptimizationMethod..............................................................................................80 Functions....................................................................................................................................................80 ControlCubes........................................................................................................................................80 ControlDimensions...............................................................................................................................80 Cube.DimensionsStorageOrder...........................................................................................................80 GetOIDCKeys........................................................................................................................................81 Cellset.GetPartition..............................................................................................................................81 MessageLog..........................................................................................................................................81 ModelCubes..........................................................................................................................................82 ModelDimensions.................................................................................................................................82 TailMessageLog....................................................................................................................................82 v TailTransactionLog................................................................................................................................82 TransactionLog.....................................................................................................................................83 Actions.......................................................................................................................................................83 Chore.Activate......................................................................................................................................83 Dimension.AddAllLeavesHierarchy.....................................................................................................83 BeginChangeSet...................................................................................................................................84 Thread.CancelOperation......................................................................................................................84 Cube.CheckFeeders..............................................................................................................................84 Cube.CheckRules..................................................................................................................................85 Session.Close........................................................................................................................................85 Process.Compile...................................................................................................................................85 CompileProcess....................................................................................................................................85 ProcessDebugContext.Continue..........................................................................................................86 Entry.Copy.............................................................................................................................................86 Hierarchy.CreateSessionSubset...........................................................................................................86 Chore.Deactivate..................................................................................................................................87 Process.Debug......................................................................................................................................87 DecryptDataFile....................................................................................................................................88 DecryptDataModel...............................................................................................................................88 DeleteAnnotationArtifacts...................................................................................................................88 Sandbox.DiscardChanges....................................................................................................................88 User.Disconnect....................................................................................................................................89 EncryptDataFile....................................................................................................................................89 EncryptDataModel................................................................................................................................89 EndChangeSet......................................................................................................................................89 MDXView.Execute.................................................................................................................................90 NativeView.Execute..............................................................................................................................90 Process.Execute...................................................................................................................................90 CubeDrillthrough.Execute....................................................................................................................91 RelationalDrillthrough.Execute............................................................................................................91 Chore.Execute......................................................................................................................................91 ExecuteChore.......................................................................................................................................92 ExecuteCubeDrillthrough.....................................................................................................................92 ExecuteMDX.........................................................................................................................................92 ExecuteMDXSetExpression..................................................................................................................93 ExecuteProcess....................................................................................................................................93 ExecuteProcessWithReturn.................................................................................................................93 ExecuteRelationalDrillthrough.............................................................................................................94 Process.ExecuteWithReturn................................................................................................................94 Sandbox.Load.......................................................................................................................................94 Cube.Lock.............................................................................................................................................95 Dimension.Lock....................................................................................................................................95 Sandbox.Merge.....................................................................................................................................95 Entry.Move............................................................................................................................................96 Sandbox.Publish...................................................................................................................................96 RemoveOIDCKeyFromCache...............................................................................................................97 Cube.ReorderDimensions....................................................................................................................97 RotateDataModelKey...........................................................................................................................97 Dimension.SaveAs................................................................................................................................97 Hierarchy.SaveAs..................................................................................................................................98 Subset.SaveAs......................................................................................................................................99 Cellset.SaveViewAs..............................................................................................................................99 Element.SetComponent.....................................................................................................................100 Hierarchy.SetElement........................................................................................................................100 Subset.SetElement............................................................................................................................101 Chore.SetServerLocalStartTime........................................................................................................101 ProcessDebugContext.StepIn............................................................................................................102 ProcessDebugContext.StepOut.........................................................................................................102 vi ProcessDebugContext.StepOver.......................................................................................................102 Cube.TraceCellCalculation.................................................................................................................102 Cube.TraceFeeders.............................................................................................................................103 UndoChangeSet..................................................................................................................................103 Sandbox.Unload.................................................................................................................................104 Cube.Unlock.......................................................................................................................................104 Dimension.Unlock..............................................................................................................................104 Cellset.Update....................................................................................................................................104 Cube.Update.......................................................................................................................................105 Update................................................................................................................................................105 Cellset.UpdateCells............................................................................................................................106 Cube.UpdateCells...............................................................................................................................107 Release notes..........................................................................................................................................107 What's new in 11.4.0.........................................................................................................................107 What's new in 11.3.0.........................................................................................................................107 What's new in 11.2.0.........................................................................................................................108 What's new in 11.1.0.1......................................................................................................................108 What's new in 11.1.0.0......................................................................................................................108 What's new in 11.0.0.0......................................................................................................................109 What's new in 10.2.2.7......................................................................................................................111 What's new in 10.2.2.6......................................................................................................................111 What's new in 10.2.2.5......................................................................................................................111 What's new in 10.2.2.4......................................................................................................................112 What's new in 10.2.2.3......................................................................................................................112 What's new in 10.2.2.2......................................................................................................................112 What's new in 10.2.2.1......................................................................................................................112 What's new in 10.2.2.0......................................................................................................................113 Chapter 5. Representing TM1 data..................................................................... 115 Discovering an OData service..................................................................................................................115 EDM structure..........................................................................................................................................116 Cubes and native views...........................................................................................................................119 View a cube........................................................................................................................................119 Display the available views in a cube................................................................................................119 Get the specification of a view...........................................................................................................120 Use options to view specific properties.............................................................................................121 List dimensions in a cube...................................................................................................................121 Expand dimensions and hierarchies in a cube..................................................................................122 Use the Or operator to specify cube rules across hierarchies..........................................................123 Delete a cube......................................................................................................................................125 Context dimensions and members.........................................................................................................125 Traverse a cube to view dimensions..................................................................................................125 Create a dimension............................................................................................................................126 Add a dimension to a cube.................................................................................................................127 Delete a dimension............................................................................................................................127 Column and row dimensions...................................................................................................................128 Expand columns and rows in a query................................................................................................128 Use options to expand and filter details............................................................................................129 Create a cube with dimensions and elements..................................................................................129 Cellsets....................................................................................................................................................131 Find cell values in a cellset................................................................................................................131 Run a view and expand the cellsets..................................................................................................132 Get the cells of a cellset in multiple partitions..................................................................................132 Preview a datasource.........................................................................................................................133 Update a single cell value..................................................................................................................134 Update many cell values....................................................................................................................135 Delete a cellset ..................................................................................................................................136 vii Elements..................................................................................................................................................136 Retrieve elements by supplying either alias or invariant name........................................................136 Update all elements in a static set....................................................................................................137 Chores......................................................................................................................................................138 Folders and contents...............................................................................................................................140 Functions and actions..............................................................................................................................141 Options and filters...................................................................................................................................142 Batch options.....................................................................................................................................142 Pagination query options...................................................................................................................143 Filter expressions...............................................................................................................................144 Attributes and localization......................................................................................................................145 Create Attributes and Captions for an entity.....................................................................................145 Use TurboIntegrator functions..........................................................................................................148 More information................................................................................................................................149 Chapter 6. Data spreading with the TM1 REST API..............................................151 Spreading overview.................................................................................................................................151 Spreading to a single leaf cell............................................................................................................151 Spreading to a consolidated cell........................................................................................................151 Spreading to a range..........................................................................................................................152 After spreading is complete...............................................................................................................152 Spreading examples................................................................................................................................152 Proportional spread, equal spread, and repeat................................................................................152 Clear....................................................................................................................................................153 Percent change...................................................................................................................................153 Straight line........................................................................................................................................154 Growth%.............................................................................................................................................154 Relative proportional spread.............................................................................................................154 Relative percent adjustment..............................................................................................................155 Repeat leaves.....................................................................................................................................155 Equal spread leaves...........................................................................................................................156 Applying holds....................................................................................................................................156 Spreading command codes.....................................................................................................................156 Chapter 7. TM1 settings.....................................................................................161 Chapter 8. Troubleshooting................................................................................163 Chapter 9. Appendix 1: TM1 Admin Host.............................................................165 Chapter 10. Notices...........................................................................................167 ©...............................................................................................................................................................168 viii Introduction You can use the IBM® Cognos® TM1® REST API to perform create, read, update, and delete operations on TM1 data by using standards that are defined by OData Version 4 (http://www.odata.org/documentation/). This document describes the semantics of the TM1 REST API and demonstrates how to use the TM1 REST API by using samples and use cases. Finding information To find documentation on the web, including all translated documentation, access IBM Knowledge Center (http://www.ibm.com/support/knowledgecenter). Audience To use the IBM Cognos TM1 REST API effectively, you must be familiar with the following areas: • TM1 and the TM1 architecture • Dimensional data and modeling terminology and concepts • OData Version 4 • REST • HTTP programming (methods, headers, result codes) • Web authentication • JSON For detailed information about how to interact with the TM1 REST API, see Chapter 5, “Representing TM1 data,” on page 115. Samples disclaimer The Sample Outdoors Company, Great Outdoors Company, GO Sales, any variation of the Sample Outdoors or Great Outdoors names, and Planning Sample depict fictitious business operations with sample data used to develop sample applications for IBM and IBM customers. These fictitious records include sample data for sales transactions, product distribution, finance, and human resources. Any resemblance to actual names, addresses, contact numbers, or transaction values is coincidental. Other sample files may contain fictional data manually or machine generated, factual data compiled from academic or public sources, or data used with permission of the copyright holder, for use as sample data to develop sample applications. Product names referenced may be the trademarks of their respective owners. Unauthorized duplication is prohibited. Accessibility features Accessibility features help users who have a physical disability, such as restricted mobility or limited vision, to use information technology products. This product does not currently support accessibility features that help users with a physical disability, such as restricted mobility or limited vision, to use this product. Forward-looking statements This documentation describes the current functionality of the product. References to items that are not currently available may be included. No implication of any future availability should be inferred. Any such references are not a commitment, promise, or legal obligation to deliver any material, code, or functionality. The development, release, and timing of features or functionality remain at the sole discretion of IBM. © Copyright IBM Corp. 2007, 2019 ix x IBM Planning Analytics TM1 REST API

Description:
The IBM Cognos TM1 REST API provides an Open Data Protocol (OData) Version 4 compliant interface to an IBM. Cognos TM1 server, which allows documentation about the provider of an OData web service (also referred to as an OData endpoint) and consumers of the OData service.
ebook img

REST API PDF

182 Pages·2017·1.27 MB·English
by  
Save to my drive
Quick download
Download
Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Download REST API PDF Free - Full Version

by Unknow| 2017| 182 pages| 1.27| English

Download REST API by in PDF format completely FREE. No registration required, no payment needed. Get instant access to this valuable resource on PDFdrive.to!

Free Download PDF

About REST API

The IBM Cognos TM1 REST API provides an Open Data Protocol (OData) Version 4 compliant interface to an IBM. Cognos TM1 server, which allows documentation about the provider of an OData web service (also referred to as an OData endpoint) and consumers of the OData service.

Detailed Information

Author:Unknown
Publication Year:2017
Pages:182
Language:English
File Size:1.27
Format:PDF
Price:FREE
Download Free PDF

Safe & Secure Download - No registration required

Why Choose PDFdrive for Your Free REST API Download?

  • 100% Free: No hidden fees or subscriptions required for one book every day.
  • No Registration: Immediate access is available without creating accounts for one book every day.
  • Safe and Secure: Clean downloads without malware or viruses
  • Multiple Formats: PDF, MOBI, Mpub,... optimized for all devices
  • Educational Resource: Supporting knowledge sharing and learning

Free Books Similar to REST API

Frequently Asked Questions

Is it really free to download REST API PDF?

Yes, on https://PDFdrive.to you can download REST API by completely free. We don't require any payment, subscription, or registration to access this PDF file. For 3 books every day.

How can I read REST API on my mobile device?

After downloading REST API PDF, you can open it with any PDF reader app on your phone or tablet. We recommend using Adobe Acrobat Reader, Apple Books, or Google Play Books for the best reading experience.

Is this the full version of REST API?

Yes, this is the complete PDF version of REST API by Unknow. You will be able to read the entire content as in the printed version without missing any pages.

Is it legal to download REST API PDF for free?

https://PDFdrive.to provides links to free educational resources available online. We do not store any files on our servers. Please be aware of copyright laws in your country before downloading.

The materials shared are intended for research, educational, and personal use in accordance with fair use principles.

Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.
We use cookies

We use cookies to ensure you get the best browsing experience on our website. By clicking "Accept Cookies", you agree that we can store cookies on your device in accordance with our Terms and Privacy.