npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/presalytics_ooxml

v3.0.0

Published

DataFire integration for OOXML Automation

Downloads

6

Readme

@datafire/presalytics_ooxml

Client library for OOXML Automation

Installation and Usage

npm install --save @datafire/presalytics_ooxml
let presalytics_ooxml = require('@datafire/presalytics_ooxml').create();

.then(data => {
  console.log(data);
});

Description

This API helps users convert Excel and Powerpoint documents into rich, live dashboards and stories.

Actions

chart_axes_get_id

Get by Id: Use this method to retrieve a Axes object by its primary key (id)

presalytics_ooxml.chart_axes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

chart_axisdatatypes_get

List Types: Use this method to retreive a list of possible options for the AxisDataTypes type. Use the Id from oneof the returned elements on to make changes to elements in the Chart object space.

presalytics_ooxml.chart_axisdatatypes_get(null, context)

Input

This action has no parameters

Output

chart_axisdatatypes_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.chart_axisdatatypes_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

chart_axisdatatypes_get_id

Get by Id: Use this method to retrieve a AxisDataTypes object by its primary key (id)

presalytics_ooxml.chart_axisdatatypes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

chart_chartdata_get_id

Get by Id: Use this method to retrieve a ChartData object by its primary key (id)

presalytics_ooxml.chart_chartdata_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

charts_charts_chartupdate_get_id

Gets a ChartDataDTO object, usually used for downstream analytics and chart updates

presalytics_ooxml.charts_charts_chartupdate_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

charts_charts_chartupdate_put_id

Simplifies chart update by allowing users to supply data via ChartDataDTO

presalytics_ooxml.charts_charts_chartupdate_put_id({
  "id": ""
}, context)

Input

Output

Output schema unknown

charts_charts_childobjects_get_id

This endpoint is helpful for helping users and bots identify dependent objects to this Chart and retreive their corresponding metadata in order to make modifications to those objects in downstream operations.

presalytics_ooxml.charts_charts_childobjects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

chart_columncollections_get_id

Get by Id: Use this method to retrieve a ColumnCollections object by its primary key (id)

presalytics_ooxml.chart_columncollections_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

chart_columns_get_id

Get by Id: Use this method to retrieve a Columns object by its primary key (id)

presalytics_ooxml.chart_columns_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

chart_datapoints_get_id

Get by Id: Use this method to retrieve a DataPoints object by its primary key (id)

presalytics_ooxml.chart_datapoints_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

charts_charts_details_get_id

Returns object metadata and information about relative dependent objects

presalytics_ooxml.charts_charts_details_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

charts_charts_openofficexml_get_id_updated

Return the subset of the xml content from within the latest edited version of the OpenXmlDocument from this Chart object. The returned xml data conforms to the Ecma-376 standard. Use this endpoint a starting point for building client-side extensions that modify Presalytics widgets containing Chart objects.

presalytics_ooxml.charts_charts_openofficexml_get_id_updated({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • updated boolean: Indicates whether API should return the orginal uploaded xml (false) or the actively updated version (true, default)

Output

charts_charts_openofficexml_put_id

Directly eidt the underlying xml of a Chart object within an OpenOpenXml (e.g. Excel, Powerpoint) document. This endpoint will validatate the submitted xml against the Ecma-376 standard prior to saving modification. Invalid xml will rejected by this endpoint and a (hopefully) helpful error message will be returned. Use this endpoint for client-side automation of modifications ot Chart objects.

presalytics_ooxml.charts_charts_openofficexml_put_id({
  "id": ""
}, context)

Input

  • input object

Output

Output schema unknown

chart_plottype_get

List Types: Use this method to retreive a list of possible options for the PlotType type. Use the Id from oneof the returned elements on to make changes to elements in the Chart object space.

presalytics_ooxml.chart_plottype_get(null, context)

Input

This action has no parameters

Output

chart_plottype_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.chart_plottype_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

chart_plottype_get_id

Get by Id: Use this method to retrieve a PlotType object by its primary key (id)

presalytics_ooxml.chart_plottype_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

chart_rowcol_get

List Types: Use this method to retreive a list of possible options for the RowCol type. Use the Id from oneof the returned elements on to make changes to elements in the Chart object space.

presalytics_ooxml.chart_rowcol_get(null, context)

Input

This action has no parameters

Output

chart_rowcol_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.chart_rowcol_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

chart_rowcol_get_id

Get by Id: Use this method to retrieve a RowCol object by its primary key (id)

presalytics_ooxml.chart_rowcol_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

chart_rowcollections_get_id

Get by Id: Use this method to retrieve a RowCollections object by its primary key (id)

presalytics_ooxml.chart_rowcollections_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

chart_rownameformattypes_get

List Types: Use this method to retreive a list of possible options for the RowNameFormatTypes type. Use the Id from oneof the returned elements on to make changes to elements in the Chart object space.

presalytics_ooxml.chart_rownameformattypes_get(null, context)

Input

This action has no parameters

Output

chart_rownameformattypes_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.chart_rownameformattypes_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

chart_rownameformattypes_get_id

Get by Id: Use this method to retrieve a RowNameFormatTypes object by its primary key (id)

presalytics_ooxml.chart_rownameformattypes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

chart_rows_get_id

Get by Id: Use this method to retrieve a Rows object by its primary key (id)

presalytics_ooxml.chart_rows_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

charts_charts_svg_get_id_use_cache

This endpoint is helpful for rending this Chart as an svg or image object that can then be rendered in a story, dashboard or website.

presalytics_ooxml.charts_charts_svg_get_id_use_cache({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • use_cache boolean: Indicates whether API should retrieve content from a cache if aviable (true, default), or force an update (false)

Output

  • output string: The file byte stream.

charts_charts_get_id

Get by Id: Use this method to retrieve a Charts object by its primary key (id)

presalytics_ooxml.charts_charts_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string: An Id of the respository DTO elemennt

Output

slides_connectionshapes_childobjects_get_id

This endpoint is helpful for helping users and bots identify dependent objects to this Slide and retreive their corresponding metadata in order to make modifications to those objects in downstream operations.

presalytics_ooxml.slides_connectionshapes_childobjects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_connectionshapes_details_get_id

Returns object metadata and information about relative dependent objects

presalytics_ooxml.slides_connectionshapes_details_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_connectionshapes_openofficexml_get_id_updated

Return the subset of the xml content from within the latest edited version of the OpenXmlDocument from this Slide object. The returned xml data conforms to the Ecma-376 standard. Use this endpoint a starting point for building client-side extensions that modify Presalytics widgets containing Slide objects.

presalytics_ooxml.slides_connectionshapes_openofficexml_get_id_updated({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • updated boolean: Indicates whether API should return the orginal uploaded xml (false) or the actively updated version (true, default)

Output

slides_connectionshapes_openofficexml_put_id

Directly eidt the underlying xml of a Slide object within an OpenOpenXml (e.g. Excel, Powerpoint) document. This endpoint will validatate the submitted xml against the Ecma-376 standard prior to saving modification. Invalid xml will rejected by this endpoint and a (hopefully) helpful error message will be returned. Use this endpoint for client-side automation of modifications ot Slide objects.

presalytics_ooxml.slides_connectionshapes_openofficexml_put_id({
  "id": ""
}, context)

Input

  • input object

Output

Output schema unknown

slides_connectionshapes_svg_get_id_use_cache

This endpoint is helpful for rending this Slide as an svg or image object that can then be rendered in a story, dashboard or website.

presalytics_ooxml.slides_connectionshapes_svg_get_id_use_cache({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • use_cache boolean: Indicates whether API should retrieve content from a cache if aviable (true, default), or force an update (false)

Output

  • output string: The file byte stream.

slides_connectionshapes_get_id

Get by Id: Use this method to retrieve a ConnectionShapes object by its primary key (id)

presalytics_ooxml.slides_connectionshapes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string: An Id of the respository DTO elemennt

Output

documents_post

Upload an OpenOfficeXml document (e.g., .xlsx, .pptx) for processing by the API.

presalytics_ooxml.documents_post({
  "file": "",
  "storyId": ""
}, context)

Input

  • input object
    • file required string: The file to upload. Must be of type .pptx, ppt
    • storyId required string: The story_id of the document being uploaded.

Output

documents_childobjects_get_id

This endpoint is helpful for helping users and bots identify dependent objects to this DocumentsController and retreive their corresponding metadata in order to make modifications to those objects in downstream operations.

presalytics_ooxml.documents_childobjects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

documents_clone_post_id

Clone A Document that has already been uploaded to a new Story

presalytics_ooxml.documents_clone_post_id({
  "id": ""
}, context)

Input

Output

documents_documenttype_get

List Types: Use this method to retreive a list of possible options for the DocumentType type. Use the Id from oneof the returned elements on to make changes to elements in the Documents object space.

presalytics_ooxml.documents_documenttype_get(null, context)

Input

This action has no parameters

Output

documents_documenttype_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.documents_documenttype_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

documents_documenttype_get_id

Get by Id: Use this method to retrieve a DocumentType object by its primary key (id)

presalytics_ooxml.documents_documenttype_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

documents_download_get_id_orginal

Download the into a bytestream for client-side processing.

presalytics_ooxml.documents_download_get_id_orginal({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • orginal boolean

Output

  • output string

documents_delete_id

Permantly delete a document from the Ooxml Automation API. Note that is does not make changes to the related Presalytics APIs. Please use the delete endpoint in the story API to ensure that stories are not left with orphaned references to the Ooxml Automation API.

presalytics_ooxml.documents_delete_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

Output schema unknown

documents_get_id

Get by Id: Use this method to retrieve a Documents object by its primary key (id)

presalytics_ooxml.documents_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_groups_childobjects_get_id

This endpoint is helpful for helping users and bots identify dependent objects to this Slide and retreive their corresponding metadata in order to make modifications to those objects in downstream operations.

presalytics_ooxml.slides_groups_childobjects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_groups_details_get_id

Returns object metadata and information about relative dependent objects

presalytics_ooxml.slides_groups_details_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_groups_openofficexml_get_id_updated

Return the subset of the xml content from within the latest edited version of the OpenXmlDocument from this Slide object. The returned xml data conforms to the Ecma-376 standard. Use this endpoint a starting point for building client-side extensions that modify Presalytics widgets containing Slide objects.

presalytics_ooxml.slides_groups_openofficexml_get_id_updated({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • updated boolean: Indicates whether API should return the orginal uploaded xml (false) or the actively updated version (true, default)

Output

slides_groups_openofficexml_put_id

Directly eidt the underlying xml of a Slide object within an OpenOpenXml (e.g. Excel, Powerpoint) document. This endpoint will validatate the submitted xml against the Ecma-376 standard prior to saving modification. Invalid xml will rejected by this endpoint and a (hopefully) helpful error message will be returned. Use this endpoint for client-side automation of modifications ot Slide objects.

presalytics_ooxml.slides_groups_openofficexml_put_id({
  "id": ""
}, context)

Input

  • input object

Output

Output schema unknown

slides_groups_svg_get_id_use_cache

This endpoint is helpful for rending this Slide as an svg or image object that can then be rendered in a story, dashboard or website.

presalytics_ooxml.slides_groups_svg_get_id_use_cache({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • use_cache boolean: Indicates whether API should retrieve content from a cache if aviable (true, default), or force an update (false)

Output

  • output string: The file byte stream.

slides_groups_get_id

Get by Id: Use this method to retrieve a Groups object by its primary key (id)

presalytics_ooxml.slides_groups_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string: An Id of the respository DTO elemennt

Output

shared_images_childobjects_get_id

This endpoint is helpful for helping users and bots identify dependent objects to this Shared and retreive their corresponding metadata in order to make modifications to those objects in downstream operations.

presalytics_ooxml.shared_images_childobjects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_images_details_get_id

Returns object metadata and information about relative dependent objects

presalytics_ooxml.shared_images_details_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_images_getimage_put_id

Download Images extracted from Ooxml Documents

presalytics_ooxml.shared_images_getimage_put_id({
  "Id": ""
}, context)

Input

  • input object
    • Id required string: The Image Id

Output

Output schema unknown

shared_images_openofficexml_get_id_updated

Return the subset of the xml content from within the latest edited version of the OpenXmlDocument from this Shared object. The returned xml data conforms to the Ecma-376 standard. Use this endpoint a starting point for building client-side extensions that modify Presalytics widgets containing Shared objects.

presalytics_ooxml.shared_images_openofficexml_get_id_updated({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • updated boolean: Indicates whether API should return the orginal uploaded xml (false) or the actively updated version (true, default)

Output

shared_images_openofficexml_put_id

Directly eidt the underlying xml of a Shared object within an OpenOpenXml (e.g. Excel, Powerpoint) document. This endpoint will validatate the submitted xml against the Ecma-376 standard prior to saving modification. Invalid xml will rejected by this endpoint and a (hopefully) helpful error message will be returned. Use this endpoint for client-side automation of modifications ot Shared objects.

presalytics_ooxml.shared_images_openofficexml_put_id({
  "id": ""
}, context)

Input

  • input object

Output

Output schema unknown

shared_images_svg_get_id_use_cache

This endpoint is helpful for rending this Shared as an svg or image object that can then be rendered in a story, dashboard or website.

presalytics_ooxml.shared_images_svg_get_id_use_cache({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • use_cache boolean: Indicates whether API should retrieve content from a cache if aviable (true, default), or force an update (false)

Output

  • output string: The file byte stream.

shared_images_get_id

Get by Id: Use this method to retrieve a Images object by its primary key (id)

presalytics_ooxml.shared_images_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string: An Id of the respository DTO elemennt

Output

slides_shapetrees_childobjects_get_id

This endpoint is helpful for helping users and bots identify dependent objects to this Slide and retreive their corresponding metadata in order to make modifications to those objects in downstream operations.

presalytics_ooxml.slides_shapetrees_childobjects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_shapetrees_details_get_id

Returns object metadata and information about relative dependent objects

presalytics_ooxml.slides_shapetrees_details_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_shapetrees_openofficexml_get_id_updated

Return the subset of the xml content from within the latest edited version of the OpenXmlDocument from this Slide object. The returned xml data conforms to the Ecma-376 standard. Use this endpoint a starting point for building client-side extensions that modify Presalytics widgets containing Slide objects.

presalytics_ooxml.slides_shapetrees_openofficexml_get_id_updated({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • updated boolean: Indicates whether API should return the orginal uploaded xml (false) or the actively updated version (true, default)

Output

slides_shapetrees_openofficexml_put_id

Directly eidt the underlying xml of a Slide object within an OpenOpenXml (e.g. Excel, Powerpoint) document. This endpoint will validatate the submitted xml against the Ecma-376 standard prior to saving modification. Invalid xml will rejected by this endpoint and a (hopefully) helpful error message will be returned. Use this endpoint for client-side automation of modifications ot Slide objects.

presalytics_ooxml.slides_shapetrees_openofficexml_put_id({
  "id": ""
}, context)

Input

  • input object

Output

Output schema unknown

slides_shapetrees_svg_get_id_use_cache

This endpoint is helpful for rending this Slide as an svg or image object that can then be rendered in a story, dashboard or website.

presalytics_ooxml.slides_shapetrees_svg_get_id_use_cache({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • use_cache boolean: Indicates whether API should retrieve content from a cache if aviable (true, default), or force an update (false)

Output

  • output string: The file byte stream.

slides_shapetrees_get_id

Get by Id: Use this method to retrieve a ShapeTrees object by its primary key (id)

presalytics_ooxml.slides_shapetrees_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string: An Id of the respository DTO elemennt

Output

slides_shapes_childobjects_get_id

This endpoint is helpful for helping users and bots identify dependent objects to this Slide and retreive their corresponding metadata in order to make modifications to those objects in downstream operations.

presalytics_ooxml.slides_shapes_childobjects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_shapes_details_get_id

Returns object metadata and information about relative dependent objects

presalytics_ooxml.slides_shapes_details_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_shapes_openofficexml_get_id_updated

Return the subset of the xml content from within the latest edited version of the OpenXmlDocument from this Slide object. The returned xml data conforms to the Ecma-376 standard. Use this endpoint a starting point for building client-side extensions that modify Presalytics widgets containing Slide objects.

presalytics_ooxml.slides_shapes_openofficexml_get_id_updated({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • updated boolean: Indicates whether API should return the orginal uploaded xml (false) or the actively updated version (true, default)

Output

slides_shapes_openofficexml_put_id

Directly eidt the underlying xml of a Slide object within an OpenOpenXml (e.g. Excel, Powerpoint) document. This endpoint will validatate the submitted xml against the Ecma-376 standard prior to saving modification. Invalid xml will rejected by this endpoint and a (hopefully) helpful error message will be returned. Use this endpoint for client-side automation of modifications ot Slide objects.

presalytics_ooxml.slides_shapes_openofficexml_put_id({
  "id": ""
}, context)

Input

  • input object

Output

Output schema unknown

slides_shapes_svg_get_id_use_cache

This endpoint is helpful for rending this Slide as an svg or image object that can then be rendered in a story, dashboard or website.

presalytics_ooxml.slides_shapes_svg_get_id_use_cache({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • use_cache boolean: Indicates whether API should retrieve content from a cache if aviable (true, default), or force an update (false)

Output

  • output string: The file byte stream.

slides_shapes_get_id

Get by Id: Use this method to retrieve a Shapes object by its primary key (id)

presalytics_ooxml.slides_shapes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string: An Id of the respository DTO elemennt

Output

shared_colortransformationattributes_get_id

Get by Id: Use this method to retrieve a ColorTransformationAttributes object by its primary key (id)

presalytics_ooxml.shared_colortransformationattributes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_colortransformations_get_id

Get by Id: Use this method to retrieve a ColorTransformations object by its primary key (id)

presalytics_ooxml.shared_colortransformations_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_colortypes_get

List Types: Use this method to retreive a list of possible options for the ColorTypes type. Use the Id from oneof the returned elements on to make changes to elements in the Shared object space.

presalytics_ooxml.shared_colortypes_get(null, context)

Input

This action has no parameters

Output

shared_colortypes_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.shared_colortypes_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

shared_colortypes_get_id

Get by Id: Use this method to retrieve a ColorTypes object by its primary key (id)

presalytics_ooxml.shared_colortypes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_dashtypes_get

List Types: Use this method to retreive a list of possible options for the DashTypes type. Use the Id from oneof the returned elements on to make changes to elements in the Shared object space.

presalytics_ooxml.shared_dashtypes_get(null, context)

Input

This action has no parameters

Output

shared_dashtypes_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.shared_dashtypes_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

shared_dashtypes_get_id

Get by Id: Use this method to retrieve a DashTypes object by its primary key (id)

presalytics_ooxml.shared_dashtypes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_effectattributes_get_id

Get by Id: Use this method to retrieve a EffectAttributes object by its primary key (id)

presalytics_ooxml.shared_effectattributes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_effecttypes_get

List Types: Use this method to retreive a list of possible options for the EffectTypes type. Use the Id from oneof the returned elements on to make changes to elements in the Shared object space.

presalytics_ooxml.shared_effecttypes_get(null, context)

Input

This action has no parameters

Output

shared_effecttypes_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.shared_effecttypes_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

shared_effecttypes_get_id

Get by Id: Use this method to retrieve a EffectTypes object by its primary key (id)

presalytics_ooxml.shared_effecttypes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_effects_get_id

Get by Id: Use this method to retrieve a Effects object by its primary key (id)

presalytics_ooxml.shared_effects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_fillmap_get_id

Get by Id: Use this method to retrieve a FillMap object by its primary key (id)

presalytics_ooxml.shared_fillmap_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_filltypes_get

List Types: Use this method to retreive a list of possible options for the FillTypes type. Use the Id from oneof the returned elements on to make changes to elements in the Shared object space.

presalytics_ooxml.shared_filltypes_get(null, context)

Input

This action has no parameters

Output

shared_filltypes_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.shared_filltypes_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

shared_filltypes_get_id

Get by Id: Use this method to retrieve a FillTypes object by its primary key (id)

presalytics_ooxml.shared_filltypes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_gradientfills_get_id

Get by Id: Use this method to retrieve a GradientFills object by its primary key (id)

presalytics_ooxml.shared_gradientfills_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_gradientstops_get_id

Get by Id: Use this method to retrieve a GradientStops object by its primary key (id)

presalytics_ooxml.shared_gradientstops_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_imagefills_get_id

Get by Id: Use this method to retrieve a ImageFills object by its primary key (id)

presalytics_ooxml.shared_imagefills_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_lineendsizes_get

List Types: Use this method to retreive a list of possible options for the LineEndSizes type. Use the Id from oneof the returned elements on to make changes to elements in the Shared object space.

presalytics_ooxml.shared_lineendsizes_get(null, context)

Input

This action has no parameters

Output

shared_lineendsizes_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.shared_lineendsizes_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

shared_lineendsizes_get_id

Get by Id: Use this method to retrieve a LineEndSizes object by its primary key (id)

presalytics_ooxml.shared_lineendsizes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_lineendtypes_get

List Types: Use this method to retreive a list of possible options for the LineEndTypes type. Use the Id from oneof the returned elements on to make changes to elements in the Shared object space.

presalytics_ooxml.shared_lineendtypes_get(null, context)

Input

This action has no parameters

Output

shared_lineendtypes_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.shared_lineendtypes_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

shared_lineendtypes_get_id

Get by Id: Use this method to retrieve a LineEndTypes object by its primary key (id)

presalytics_ooxml.shared_lineendtypes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_lines_get_id

Get by Id: Use this method to retrieve a Lines object by its primary key (id)

presalytics_ooxml.shared_lines_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_paragraph_get_id

Get by Id: Use this method to retrieve a Paragraph object by its primary key (id)

presalytics_ooxml.shared_paragraph_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_solidfills_get_id

Get by Id: Use this method to retrieve a SolidFills object by its primary key (id)

presalytics_ooxml.shared_solidfills_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_text_get_id

Get by Id: Use this method to retrieve a Text object by its primary key (id)

presalytics_ooxml.shared_text_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

shared_textcontainer_get_id

Get by Id: Use this method to retrieve a TextContainer object by its primary key (id)

presalytics_ooxml.shared_textcontainer_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_slides_childobjects_get_id

This endpoint is helpful for helping users and bots identify dependent objects to this Slide and retreive their corresponding metadata in order to make modifications to those objects in downstream operations.

presalytics_ooxml.slides_slides_childobjects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_colormaps_get_id

Get by Id: Use this method to retrieve a ColorMaps object by its primary key (id)

presalytics_ooxml.slides_colormaps_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_slides_details_get_id

Returns object metadata and information about relative dependent objects

presalytics_ooxml.slides_slides_details_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_graphictypes_get

List Types: Use this method to retreive a list of possible options for the GraphicTypes type. Use the Id from oneof the returned elements on to make changes to elements in the Slides object space.

presalytics_ooxml.slides_graphictypes_get(null, context)

Input

This action has no parameters

Output

slides_graphictypes_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.slides_graphictypes_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

slides_graphictypes_get_id

Get by Id: Use this method to retrieve a GraphicTypes object by its primary key (id)

presalytics_ooxml.slides_graphictypes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_graphics_get_id

Get by Id: Use this method to retrieve a Graphics object by its primary key (id)

presalytics_ooxml.slides_graphics_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_groupelementtypes_get

List Types: Use this method to retreive a list of possible options for the GroupElementTypes type. Use the Id from oneof the returned elements on to make changes to elements in the Slides object space.

presalytics_ooxml.slides_groupelementtypes_get(null, context)

Input

This action has no parameters

Output

slides_groupelementtypes_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.slides_groupelementtypes_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

slides_groupelementtypes_get_id

Get by Id: Use this method to retrieve a GroupElementTypes object by its primary key (id)

presalytics_ooxml.slides_groupelementtypes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_groupelements_get_id

Get by Id: Use this method to retrieve a GroupElements object by its primary key (id)

presalytics_ooxml.slides_groupelements_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_slides_openofficexml_get_id_updated

Return the subset of the xml content from within the latest edited version of the OpenXmlDocument from this Slide object. The returned xml data conforms to the Ecma-376 standard. Use this endpoint a starting point for building client-side extensions that modify Presalytics widgets containing Slide objects.

presalytics_ooxml.slides_slides_openofficexml_get_id_updated({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • updated boolean: Indicates whether API should return the orginal uploaded xml (false) or the actively updated version (true, default)

Output

slides_slides_openofficexml_put_id

Directly eidt the underlying xml of a Slide object within an OpenOpenXml (e.g. Excel, Powerpoint) document. This endpoint will validatate the submitted xml against the Ecma-376 standard prior to saving modification. Invalid xml will rejected by this endpoint and a (hopefully) helpful error message will be returned. Use this endpoint for client-side automation of modifications ot Slide objects.

presalytics_ooxml.slides_slides_openofficexml_put_id({
  "id": ""
}, context)

Input

  • input object

Output

Output schema unknown

slides_slidemasters_get_id

Get by Id: Use this method to retrieve a SlideMasters object by its primary key (id)

presalytics_ooxml.slides_slidemasters_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_slides_svg_get_id_use_cache

This endpoint is helpful for rending this Slide as an svg or image object that can then be rendered in a story, dashboard or website.

presalytics_ooxml.slides_slides_svg_get_id_use_cache({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • use_cache boolean: Indicates whether API should retrieve content from a cache if aviable (true, default), or force an update (false)

Output

  • output string: The file byte stream.

slides_slides_get_id

Get by Id: Use this method to retrieve a Slides object by its primary key (id)

presalytics_ooxml.slides_slides_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string: An Id of the respository DTO elemennt

Output

slides_smartarts_childobjects_get_id

This endpoint is helpful for helping users and bots identify dependent objects to this Slide and retreive their corresponding metadata in order to make modifications to those objects in downstream operations.

presalytics_ooxml.slides_smartarts_childobjects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_smartarts_details_get_id

Returns object metadata and information about relative dependent objects

presalytics_ooxml.slides_smartarts_details_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

slides_smartarts_openofficexml_get_id_updated

Return the subset of the xml content from within the latest edited version of the OpenXmlDocument from this Slide object. The returned xml data conforms to the Ecma-376 standard. Use this endpoint a starting point for building client-side extensions that modify Presalytics widgets containing Slide objects.

presalytics_ooxml.slides_smartarts_openofficexml_get_id_updated({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • updated boolean: Indicates whether API should return the orginal uploaded xml (false) or the actively updated version (true, default)

Output

slides_smartarts_openofficexml_put_id

Directly eidt the underlying xml of a Slide object within an OpenOpenXml (e.g. Excel, Powerpoint) document. This endpoint will validatate the submitted xml against the Ecma-376 standard prior to saving modification. Invalid xml will rejected by this endpoint and a (hopefully) helpful error message will be returned. Use this endpoint for client-side automation of modifications ot Slide objects.

presalytics_ooxml.slides_smartarts_openofficexml_put_id({
  "id": ""
}, context)

Input

  • input object

Output

Output schema unknown

slides_smartarts_svg_get_id_use_cache

This endpoint is helpful for rending this Slide as an svg or image object that can then be rendered in a story, dashboard or website.

presalytics_ooxml.slides_smartarts_svg_get_id_use_cache({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • use_cache boolean: Indicates whether API should retrieve content from a cache if aviable (true, default), or force an update (false)

Output

  • output string: The file byte stream.

slides_smartarts_get_id

Get by Id: Use this method to retrieve a SmartArts object by its primary key (id)

presalytics_ooxml.slides_smartarts_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string: An Id of the respository DTO elemennt

Output

tables_borders_get_id

Get by Id: Use this method to retrieve a Borders object by its primary key (id)

presalytics_ooxml.tables_borders_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

tables_cells_get_id

Get by Id: Use this method to retrieve a Cells object by its primary key (id)

presalytics_ooxml.tables_cells_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

tables_tables_childobjects_get_id

This endpoint is helpful for helping users and bots identify dependent objects to this Table and retreive their corresponding metadata in order to make modifications to those objects in downstream operations.

presalytics_ooxml.tables_tables_childobjects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

tables_columns_get_id

Get by Id: Use this method to retrieve a Columns object by its primary key (id)

presalytics_ooxml.tables_columns_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

tables_tables_details_get_id

Returns object metadata and information about relative dependent objects

presalytics_ooxml.tables_tables_details_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

tables_tables_openofficexml_get_id_updated

Return the subset of the xml content from within the latest edited version of the OpenXmlDocument from this Table object. The returned xml data conforms to the Ecma-376 standard. Use this endpoint a starting point for building client-side extensions that modify Presalytics widgets containing Table objects.

presalytics_ooxml.tables_tables_openofficexml_get_id_updated({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • updated boolean: Indicates whether API should return the orginal uploaded xml (false) or the actively updated version (true, default)

Output

tables_tables_openofficexml_put_id

Directly eidt the underlying xml of a Table object within an OpenOpenXml (e.g. Excel, Powerpoint) document. This endpoint will validatate the submitted xml against the Ecma-376 standard prior to saving modification. Invalid xml will rejected by this endpoint and a (hopefully) helpful error message will be returned. Use this endpoint for client-side automation of modifications ot Table objects.

presalytics_ooxml.tables_tables_openofficexml_put_id({
  "id": ""
}, context)

Input

  • input object

Output

Output schema unknown

tables_rows_get_id

Get by Id: Use this method to retrieve a Rows object by its primary key (id)

presalytics_ooxml.tables_rows_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

tables_tables_svg_get_id_use_cache

This endpoint is helpful for rending this Table as an svg or image object that can then be rendered in a story, dashboard or website.

presalytics_ooxml.tables_tables_svg_get_id_use_cache({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • use_cache boolean: Indicates whether API should retrieve content from a cache if aviable (true, default), or force an update (false)

Output

  • output string: The file byte stream.

tables_tables_tableupdate_get_id

Gets a TabletDataDTO object, usually used for downstream updates to table content

presalytics_ooxml.tables_tables_tableupdate_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

tables_tables_tableupdate_put_id

Simplifies table update by allowing users to supply strings to table cells via TableDataDTO

presalytics_ooxml.tables_tables_tableupdate_put_id({
  "id": ""
}, context)

Input

Output

Output schema unknown

tables_tables_get_id

Get by Id: Use this method to retrieve a Tables object by its primary key (id)

presalytics_ooxml.tables_tables_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string: An Id of the respository DTO elemennt

Output

themes_backgroundfills_get_id

Get by Id: Use this method to retrieve a BackgroundFills object by its primary key (id)

presalytics_ooxml.themes_backgroundfills_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

theme_themes_childobjects_get_id

This endpoint is helpful for helping users and bots identify dependent objects to this Theme and retreive their corresponding metadata in order to make modifications to those objects in downstream operations.

presalytics_ooxml.theme_themes_childobjects_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

themes_colors_get_id

Get by Id: Use this method to retrieve a Colors object by its primary key (id)

presalytics_ooxml.themes_colors_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

themes_customcolors_get_id

Get by Id: Use this method to retrieve a CustomColors object by its primary key (id)

presalytics_ooxml.themes_customcolors_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

theme_themes_details_get_id

Returns object metadata and information about relative dependent objects

presalytics_ooxml.theme_themes_details_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

themes_effectmap_get_id

Get by Id: Use this method to retrieve a EffectMap object by its primary key (id)

presalytics_ooxml.themes_effectmap_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

themes_fills_get_id

Get by Id: Use this method to retrieve a Fills object by its primary key (id)

presalytics_ooxml.themes_fills_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

themes_fonts_get_id

Get by Id: Use this method to retrieve a Fonts object by its primary key (id)

presalytics_ooxml.themes_fonts_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

themes_intensity_get

List Types: Use this method to retreive a list of possible options for the Intensity type. Use the Id from oneof the returned elements on to make changes to elements in the Themes object space.

presalytics_ooxml.themes_intensity_get(null, context)

Input

This action has no parameters

Output

themes_intensity_typeid_get_type_id

This endpoint returns Type metadata from an integer type_id that can found on objects throughout the api.

presalytics_ooxml.themes_intensity_typeid_get_type_id({
  "type_id": 0
}, context)

Input

  • input object
    • type_id required integer

Output

themes_intensity_get_id

Get by Id: Use this method to retrieve a Intensity object by its primary key (id)

presalytics_ooxml.themes_intensity_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

themes_linemap_get_id

Get by Id: Use this method to retrieve a LineMap object by its primary key (id)

presalytics_ooxml.themes_linemap_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string

Output

theme_themes_openofficexml_get_id_updated

Return the subset of the xml content from within the latest edited version of the OpenXmlDocument from this Theme object. The returned xml data conforms to the Ecma-376 standard. Use this endpoint a starting point for building client-side extensions that modify Presalytics widgets containing Theme objects.

presalytics_ooxml.theme_themes_openofficexml_get_id_updated({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • updated boolean: Indicates whether API should return the orginal uploaded xml (false) or the actively updated version (true, default)

Output

theme_themes_openofficexml_put_id

Directly eidt the underlying xml of a Theme object within an OpenOpenXml (e.g. Excel, Powerpoint) document. This endpoint will validatate the submitted xml against the Ecma-376 standard prior to saving modification. Invalid xml will rejected by this endpoint and a (hopefully) helpful error message will be returned. Use this endpoint for client-side automation of modifications ot Theme objects.

presalytics_ooxml.theme_themes_openofficexml_put_id({
  "id": ""
}, context)

Input

  • input object

Output

Output schema unknown

theme_themes_svg_get_id_use_cache

This endpoint is helpful for rending this Theme as an svg or image object that can then be rendered in a story, dashboard or website.

presalytics_ooxml.theme_themes_svg_get_id_use_cache({
  "id": ""
}, context)

Input

  • input object
    • id required string
    • use_cache boolean: Indicates whether API should retrieve content from a cache if aviable (true, default), or force an update (false)

Output

  • output string: The file byte stream.

theme_themes_get_id

Get by Id: Use this method to retrieve a Themes object by its primary key (id)

presalytics_ooxml.theme_themes_get_id({
  "id": ""
}, context)

Input

  • input object
    • id required string: An Id of the respository DTO elemennt

Output

Definitions

Chart.Axes

  • Chart.Axes object
    • axisDataTypeId integer
    • chartsId string
    • id string
    • ooxmlId integer

Chart.Axes.Details

Chart.AxisDataTypes

  • Chart.AxisDataTypes object
    • description string
    • id string
    • name string
    • ooxmlName string
    • typeId integer

Chart.ChartData

  • Chart.ChartData object
    • chartId string
    • id string

Chart.ChartData.Details

Chart.ChartDataDTO

  • Chart.ChartDataDTO object
    • categoryNames array
      • items string
    • chartId string
    • dataPoints array
      • items array
        • items number
    • seriesNames array
      • items string

Chart.Charts

  • Chart.Charts object
    • baseElementBlobUrl string
    • changedBaseElementBlobUrl string
    • id string
    • name string
    • packageUri string
    • parentGraphicId string
    • svgBlobUrl string

Chart.Charts.Details

Chart.ColumnCollections

  • Chart.ColumnCollections object
    • chartDataId string
    • id string

Chart.ColumnCollections.Details

Chart.Columns

  • Chart.Columns object
    • axisId string
    • columnCollectionId string
    • id string
    • index integer
    • name string

Chart.Columns.Details