Where can I find a description of each property of a response obtained from the SOAP API

[Cyrille Dakhlia]

Hello there!

I am new to Spotfire and I am currently exploring the SOAP API in order to get informations about the items I have in my Library, but I don't understand some of the properties I receive in the answer. Is there a documentation that could help meexplaining what's the meaning of each property

Here's for instance one of the response I obtained, querying the"Sales and Marketing"analysis file from the sample data with the "getItems"request from the Library Service API:

 

 

 

 

0ec6b287-8a5c-4b50-b2c4-1d2470085347

Sales and Marketing

Analyzing performance of stores

and effectiveness of promotions

with the classic BCG matrix

spotfire.dxp

47a52c7b-14d4-4547-a35d-2e8aa0c19f29

 

ba9b7788-98af-4be3-9272-c4db6263499b

 

some_name

SPOTFIRE

 

a_displayed_name

an@email.com

true

 

2021-12-06T11:05:53.180Z

2021-12-06T11:05:53.180Z

2021-12-07T19:28:04.315Z

1580939

 

EmbedAllSourceData

 

True

 

 

 

SavedByAssemblyFileVersion

 

53.0.16605.3360

 

 

 

EmbeddedDataFormatVersion

 

2

 

 

 

Spotfire.TableCount

 

2

 

 

 

spotfire.Comments

 

RequiresReadAccess

 

 

 

Spotfire.Preview.Thumb

 

some long value here

 

 

 

Spotfire.PageCount

 

4

 

 

 

Spotfire.TotalTableLoadTime

 

376

 

 

 

spotfire.PrivateBookmarkCreation

 

RequiresReadAccess

 

 

 

Spotfire.VisualizationDataMemorySize

 

313352

 

 

 

Spotfire.Preview.Mode

 

Manual

 

 

 

Spotfire.DocumentLoadTime

 

365

 

 

 

Spotfire.DocumentNodeCount

 

22208

 

 

 

Spotfire.TableMemorySize

 

427584

 

 

 

spotfire.PublicBookmarkCreation

 

RequiresReadAndWriteAccess

 

 

 

Spotfire.ColumnCount

 

85

 

 

 

AllowWebPlayerResume

 

True

 

 

 

Spotfire.VisualizationCount

 

14

 

 

 

Spotfire.EmbeddedDataLoadTime

 

6

 

 

 

 

 

 

Some of the properties are self-explained by their name (Spotfire.TableCount, Spotfire.PageCount, Spotfire.ColumnCount -> though a little bit tricky because it counts the total number of columns from all thedata tables).

Others are not that clear, surely because of my lack of knowledge and experience with Spotfire, for instance:

- Spotfire.VisualizationCount: does it mean the number of "charts" in the analysis file

- EmbeddAllSourceData: does this mean that all the data tables are embedded in the analysis file (the name is clear, but it's a big assumption that I prefer to be confirmed)

- DocumentNodeCount: I don't know what this property could mean

 

Could somebody bring me an answer for those propertiesor/and lead me to an helpful documentation

I would be really grateful.

Best regards,

Cyrille Dakhlia