331 lines
87 KiB
HTML
331 lines
87 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><style>
|
|
@media (prefers-color-scheme: dark) {
|
|
:root {
|
|
--md-sys-color-primary: #adc6ff;
|
|
--md-sys-color-on-primary: #002e6a;
|
|
--md-sys-color-primary-container: #10448f;
|
|
--md-sys-color-on-primary-container: #d8e2ff;
|
|
--md-sys-color-secondary: #bfc6dc;
|
|
--md-sys-color-on-secondary: #293041;
|
|
--md-sys-color-secondary-container: #3f4759;
|
|
--md-sys-color-on-secondary-container: #dbe2f9;
|
|
--md-sys-color-tertiary: #debcdf;
|
|
--md-sys-color-on-tertiary: #402843;
|
|
--md-sys-color-tertiary-container: #583e5b;
|
|
--md-sys-color-on-tertiary-container: #fcd7fb;
|
|
--md-sys-color-error: #ffb4ab;
|
|
--md-sys-color-on-error: #690005;
|
|
--md-sys-color-error-container: #93000a;
|
|
--md-sys-color-on-error-container: #ffb4ab;
|
|
--md-sys-color-background: #1b1b1f;
|
|
--md-sys-color-on-background: #e3e2e6;
|
|
--md-sys-color-surface: #1b1b1f;
|
|
--md-sys-color-on-surface: #e3e2e6;
|
|
--md-sys-color-surface-variant: #44474f;
|
|
--md-sys-color-on-surface-variant: #c4c6d0;
|
|
--md-sys-color-outline: #8e9099;
|
|
--md-sys-color-outline-variant: #44474f;
|
|
--md-sys-color-shadow: #000000;
|
|
--md-sys-color-scrim: #000000;
|
|
--md-sys-color-inverse-surface: #e3e2e6;
|
|
--md-sys-color-inverse-on-surface: #303034;
|
|
--md-sys-color-inverse-primary: #325da8;
|
|
--md-sys-color-surface-dim: #121316;
|
|
--md-sys-color-surface-bright: #38393c;
|
|
--md-sys-color-surface-container-lowest: #0d0e11;
|
|
--md-sys-color-surface-container-low: #1b1b1f;
|
|
--md-sys-color-surface-container: #1f1f23;
|
|
--md-sys-color-surface-container-high: #292a2d;
|
|
--md-sys-color-surface-container-highest: #343538
|
|
}
|
|
}
|
|
:root[data-theme="dark"] {
|
|
--md-sys-color-primary: #adc6ff;
|
|
--md-sys-color-on-primary: #002e6a;
|
|
--md-sys-color-primary-container: #10448f;
|
|
--md-sys-color-on-primary-container: #d8e2ff;
|
|
--md-sys-color-secondary: #bfc6dc;
|
|
--md-sys-color-on-secondary: #293041;
|
|
--md-sys-color-secondary-container: #3f4759;
|
|
--md-sys-color-on-secondary-container: #dbe2f9;
|
|
--md-sys-color-tertiary: #debcdf;
|
|
--md-sys-color-on-tertiary: #402843;
|
|
--md-sys-color-tertiary-container: #583e5b;
|
|
--md-sys-color-on-tertiary-container: #fcd7fb;
|
|
--md-sys-color-error: #ffb4ab;
|
|
--md-sys-color-on-error: #690005;
|
|
--md-sys-color-error-container: #93000a;
|
|
--md-sys-color-on-error-container: #ffb4ab;
|
|
--md-sys-color-background: #1b1b1f;
|
|
--md-sys-color-on-background: #e3e2e6;
|
|
--md-sys-color-surface: #1b1b1f;
|
|
--md-sys-color-on-surface: #e3e2e6;
|
|
--md-sys-color-surface-variant: #44474f;
|
|
--md-sys-color-on-surface-variant: #c4c6d0;
|
|
--md-sys-color-outline: #8e9099;
|
|
--md-sys-color-outline-variant: #44474f;
|
|
--md-sys-color-shadow: #000000;
|
|
--md-sys-color-scrim: #000000;
|
|
--md-sys-color-inverse-surface: #e3e2e6;
|
|
--md-sys-color-inverse-on-surface: #303034;
|
|
--md-sys-color-inverse-primary: #325da8;
|
|
--md-sys-color-surface-dim: #121316;
|
|
--md-sys-color-surface-bright: #38393c;
|
|
--md-sys-color-surface-container-lowest: #0d0e11;
|
|
--md-sys-color-surface-container-low: #1b1b1f;
|
|
--md-sys-color-surface-container: #1f1f23;
|
|
--md-sys-color-surface-container-high: #292a2d;
|
|
--md-sys-color-surface-container-highest: #343538
|
|
}
|
|
|
|
@media (prefers-color-scheme: light) {
|
|
:root {
|
|
--md-sys-color-primary: #325da8;
|
|
--md-sys-color-on-primary: #ffffff;
|
|
--md-sys-color-primary-container: #d8e2ff;
|
|
--md-sys-color-on-primary-container: #001a42;
|
|
--md-sys-color-secondary: #575e71;
|
|
--md-sys-color-on-secondary: #ffffff;
|
|
--md-sys-color-secondary-container: #dbe2f9;
|
|
--md-sys-color-on-secondary-container: #141b2c;
|
|
--md-sys-color-tertiary: #715573;
|
|
--md-sys-color-on-tertiary: #ffffff;
|
|
--md-sys-color-tertiary-container: #fcd7fb;
|
|
--md-sys-color-on-tertiary-container: #29132d;
|
|
--md-sys-color-error: #ba1a1a;
|
|
--md-sys-color-on-error: #ffffff;
|
|
--md-sys-color-error-container: #ffdad6;
|
|
--md-sys-color-on-error-container: #410002;
|
|
--md-sys-color-background: #fefbff;
|
|
--md-sys-color-on-background: #1b1b1f;
|
|
--md-sys-color-surface: #fefbff;
|
|
--md-sys-color-on-surface: #1b1b1f;
|
|
--md-sys-color-surface-variant: #e1e2ec;
|
|
--md-sys-color-on-surface-variant: #44474f;
|
|
--md-sys-color-outline: #75777f;
|
|
--md-sys-color-outline-variant: #c4c6d0;
|
|
--md-sys-color-shadow: #000000;
|
|
--md-sys-color-scrim: #000000;
|
|
--md-sys-color-inverse-surface: #303034;
|
|
--md-sys-color-inverse-on-surface: #f2f0f4;
|
|
--md-sys-color-inverse-primary: #adc6ff;
|
|
--md-sys-color-surface-dim: #dbd9dd;
|
|
--md-sys-color-surface-bright: #faf8fd;
|
|
--md-sys-color-surface-container-lowest: #ffffff;
|
|
--md-sys-color-surface-container-low: #f5f3f7;
|
|
--md-sys-color-surface-container: #efedf1;
|
|
--md-sys-color-surface-container-high: #e9e7ec;
|
|
--md-sys-color-surface-container-highest: #e3e2e6
|
|
}
|
|
}
|
|
:root[data-theme="light"] {
|
|
--md-sys-color-primary: #325da8;
|
|
--md-sys-color-on-primary: #ffffff;
|
|
--md-sys-color-primary-container: #d8e2ff;
|
|
--md-sys-color-on-primary-container: #001a42;
|
|
--md-sys-color-secondary: #575e71;
|
|
--md-sys-color-on-secondary: #ffffff;
|
|
--md-sys-color-secondary-container: #dbe2f9;
|
|
--md-sys-color-on-secondary-container: #141b2c;
|
|
--md-sys-color-tertiary: #715573;
|
|
--md-sys-color-on-tertiary: #ffffff;
|
|
--md-sys-color-tertiary-container: #fcd7fb;
|
|
--md-sys-color-on-tertiary-container: #29132d;
|
|
--md-sys-color-error: #ba1a1a;
|
|
--md-sys-color-on-error: #ffffff;
|
|
--md-sys-color-error-container: #ffdad6;
|
|
--md-sys-color-on-error-container: #410002;
|
|
--md-sys-color-background: #fefbff;
|
|
--md-sys-color-on-background: #1b1b1f;
|
|
--md-sys-color-surface: #fefbff;
|
|
--md-sys-color-on-surface: #1b1b1f;
|
|
--md-sys-color-surface-variant: #e1e2ec;
|
|
--md-sys-color-on-surface-variant: #44474f;
|
|
--md-sys-color-outline: #75777f;
|
|
--md-sys-color-outline-variant: #c4c6d0;
|
|
--md-sys-color-shadow: #000000;
|
|
--md-sys-color-scrim: #000000;
|
|
--md-sys-color-inverse-surface: #303034;
|
|
--md-sys-color-inverse-on-surface: #f2f0f4;
|
|
--md-sys-color-inverse-primary: #adc6ff;
|
|
--md-sys-color-surface-dim: #dbd9dd;
|
|
--md-sys-color-surface-bright: #faf8fd;
|
|
--md-sys-color-surface-container-lowest: #ffffff;
|
|
--md-sys-color-surface-container-low: #f5f3f7;
|
|
--md-sys-color-surface-container: #efedf1;
|
|
--md-sys-color-surface-container-high: #e9e7ec;
|
|
--md-sys-color-surface-container-highest: #e3e2e6
|
|
}
|
|
</style><link rel="stylesheet" href="assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>onspring-api-sdk</h2></div><div class="tsd-panel tsd-typography"><a id="md:onspring-api-javascript-sdk" class="tsd-anchor"></a><h1><a href="#md:onspring-api-javascript-sdk">Onspring API Javascript SDK</a></h1><p><a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/actions/workflows/lint_format_test.yaml"><img src="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/actions/workflows/lint_format_test.yaml/badge.svg?branch=master" alt="lint_format_test"></a>
|
|
<a href="https://codecov.io/github/StevanFreeborn/onspring-api-sdk-javascript"><img src="https://codecov.io/github/StevanFreeborn/onspring-api-sdk-javascript/branch/master/graph/badge.svg?token=G1L3GKE0LV" alt="codecov"></a>
|
|
<a href="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/actions/workflows/build_publish.yml"><img src="https://github.com/StevanFreeborn/onspring-api-sdk-javascript/actions/workflows/build_publish.yml/badge.svg?branch=master" alt="build_publish"></a>
|
|
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release" alt="semantic-release: angular"></a>
|
|
<a href="License.txt"><img src="https://img.shields.io/npm/l/onspring-api-sdk" alt="NPM"></a>
|
|
<img src="https://img.shields.io/npm/v/onspring-api-sdk" alt="npm">
|
|
<img src="https://img.shields.io/npm/dt/onspring-api-sdk" alt="npm"></p>
|
|
<p>The Javascript SDK for the Onspring API is meant to simplify development in Javascript for Onspring customers who want to build integrations with their Onspring instance.</p>
|
|
<p><strong>Note:</strong> This is an unofficial SDK for the Onspring API. It was not built in consultation with Onspring Technologies LLC or a member of their development team.</p>
|
|
<p>This SDK was developed independently using Onspring's existing <a href="https://github.com/onspring-technologies/onspring-api-sdk">C# SDK</a>, the Onspring API's <a href="https://api.onspring.com/swagger/index.html">swagger page</a>, and <a href="https://software.onspring.com/hubfs/Training/Admin%20Guide%20-%20v2%20API.pdf">api documentation</a> as the starting point with the intention of making development of integrations done in Javascript with an Onspring instance quicker and more convenient.</p>
|
|
<a id="md:🛠️-dependencies" class="tsd-anchor"></a><h2><a href="#md:🛠️-dependencies">🛠️ Dependencies</a></h2><a id="md:nodejs" class="tsd-anchor"></a><h3><a href="#md:nodejs">Node.js</a></h3><p><img src="https://img.shields.io/node/v/onspring-api-sdk" alt="node-current"></p>
|
|
<p>Requires use of <a href="https://nodejs.org/en/">Node.js</a> 14.x or later.</p>
|
|
<a id="md:axios" class="tsd-anchor"></a><h3><a href="#md:axios">Axios</a></h3><p><img src="https://img.shields.io/npm/dependency-version/onspring-api-sdk/axios" alt="npm (prod) dependency version"></p>
|
|
<p>All methods for the <code>OnspringClient</code> make use of the <a href="https://axios-http.com/">Axios</a> http client to interact with the Onspring API.</p>
|
|
<a id="md:form-data" class="tsd-anchor"></a><h3><a href="#md:form-data">Form-Data</a></h3><p><img src="https://img.shields.io/npm/dependency-version/onspring-api-sdk/form-data" alt="npm (prod) dependency version"></p>
|
|
<p>When it is necessary to send requests to the Onspring API using <code>multi-part/form-data</code> the <a href="https://www.npmjs.com/package/form-data">Form-Data</a> package is used.</p>
|
|
<a id="md:💾-installation" class="tsd-anchor"></a><h2><a href="#md:💾-installation">💾 Installation</a></h2><p>Install the SDK using <a href="https://www.npmjs.com/">npm</a>:</p>
|
|
<p><code>npm install onspring-api-sdk</code></p>
|
|
<a id="md:🔑-api-key" class="tsd-anchor"></a><h2><a href="#md:🔑-api-key">🔑 API Key</a></h2><p>In order to successfully interact with the Onspring Api you will need an API key. API keys are obtained by an Onspring user with permissions to at least <strong>Read</strong> API Keys for your instance via the following steps:</p>
|
|
<ol>
|
|
<li>Login to the Onspring instance.</li>
|
|
<li>Navigate to <strong>Administration</strong> > <strong>Security</strong> > <strong>API Keys</strong></li>
|
|
<li>On the list page, add a new API Key - this will require <strong>Create</strong> permissions - or click an existing API key to view its details.</li>
|
|
<li>Click on the <strong>Developer Information</strong> tab.</li>
|
|
<li>Copy the <strong>X-ApiKey Header</strong> value from this tab.</li>
|
|
</ol>
|
|
<p><strong>Important:</strong></p>
|
|
<ul>
|
|
<li>An API Key must have a status of <code>Enabled</code> in order to make authorized requests.</li>
|
|
<li>Each API Key must have an assigned Role. This role controls the permissions for requests made. If the API Key used does not have sufficient permissions the requests made won't be successful.</li>
|
|
</ul>
|
|
<a id="md:🔒-permission-considerations" class="tsd-anchor"></a><h3><a href="#md:🔒-permission-considerations">🔒 Permission Considerations</a></h3><p>You can think of any API Key as another user in your Onspring instance and therefore it is subject to all the same permission considerations as any other user when it comes to its ability to access data in your instance. The API Key you use needs to have all the correct permissions within your instance to access the data requested. Things to think about in this context are <code>role security</code>, <code>content security</code>, and <code>field security</code>.</p>
|
|
<a id="md:🧑🏻💻-start-coding" class="tsd-anchor"></a><h2><a href="#md:🧑🏻💻-start-coding">🧑🏻💻 Start Coding</a></h2><a id="md:onspringclient" class="tsd-anchor"></a><h3><a href="#md:onspringclient"><code>OnspringClient</code></a></h3><p>The most common way to use the SDK is to create an <code>OnspringClient</code> instance and call its methods. Its constructor requires two parameters:</p>
|
|
<ul>
|
|
<li><code>baseUrl</code> - currently this should always be: <code>https://api.onspring.com</code></li>
|
|
<li><code>apiKey</code> - the value obtained by following the steps in the <strong>API Key</strong> section</li>
|
|
</ul>
|
|
<p>It is best practice to read these values in from a configuration file for both flexibility and security purposes.</p>
|
|
<p>Example <code>.env</code> file:</p>
|
|
<pre><code class="language-env">API_KEY=000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000
|
|
BASE_URL=https://api.onspring.com
|
|
</code><button>Copy</button></pre>
|
|
<p>Example constructing <code>OnspringClient</code>:</p>
|
|
<p><code>CommonJS</code></p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">OnspringClient</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">dotenv</span><span class="hl-1"> = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">'dotenv'</span><span class="hl-1">);</span><br/><span class="hl-5">dotenv</span><span class="hl-1">.</span><span class="hl-3">config</span><span class="hl-1">();</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">OnspringClient</span><span class="hl-1">(</span><span class="hl-5">process</span><span class="hl-1">.</span><span class="hl-5">env</span><span class="hl-1">.</span><span class="hl-2">BASE_URL</span><span class="hl-1">, </span><span class="hl-5">process</span><span class="hl-1">.</span><span class="hl-5">env</span><span class="hl-1">.</span><span class="hl-2">API_KEY</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<p><code>ES Module</code></p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-5">dotenv</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'dotenv'</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">OnspringClient</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><span class="hl-5">dotenv</span><span class="hl-1">.</span><span class="hl-3">config</span><span class="hl-1">();</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">OnspringClient</span><span class="hl-1">(</span><span class="hl-5">process</span><span class="hl-1">.</span><span class="hl-5">env</span><span class="hl-1">.</span><span class="hl-2">BASE_URL</span><span class="hl-1">, </span><span class="hl-5">process</span><span class="hl-1">.</span><span class="hl-5">env</span><span class="hl-1">.</span><span class="hl-2">API_KEY</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:axios-instance-configuration" class="tsd-anchor"></a><h3><a href="#md:axios-instance-configuration"><code>Axios</code> Instance Configuration</a></h3><p>By default when you construct an instance of the <code>OnspringClient</code> a new <code>Axios</code> instance will also be created. Its <code>baseURL</code> property will always be set to the <code>baseUrl</code> parameter based to the <code>OnspringClient</code>'s constructor and its headers will always contain the proper <code>x-api-key</code> header.</p>
|
|
<p>You can though pass a third optional argument to the <code>OnspringClient</code> constructor that specifies additional configuration options for the <code>Axios</code> instance used to make requests.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-5">dotenv</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'dotenv'</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">OnspringClient</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><span class="hl-5">dotenv</span><span class="hl-1">.</span><span class="hl-3">config</span><span class="hl-1">();</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">configs</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">timeout:</span><span class="hl-1"> </span><span class="hl-7">5000</span><span class="hl-1">,</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">OnspringClient</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-5">process</span><span class="hl-1">.</span><span class="hl-5">env</span><span class="hl-1">.</span><span class="hl-2">BASE_URL</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">process</span><span class="hl-1">.</span><span class="hl-5">env</span><span class="hl-1">.</span><span class="hl-2">API_KEY</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">configs</span><br/><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:apiresponse" class="tsd-anchor"></a><h3><a href="#md:apiresponse"><code>ApiResponse</code></a></h3><p>Each <code>OnspringClient</code> method - aside from <code>canConnect</code> - returns an <code>ApiResponse</code> object which will have the following properties:</p>
|
|
<ul>
|
|
<li><code>statusCode</code> - The http status code of the response.</li>
|
|
<li><code>isSuccessful</code> - Indicates whether the request succeeded.</li>
|
|
<li><code>data</code> - If the request was successful will contain the response data deserialized to custom classes.</li>
|
|
<li><code>message</code> - A message that may provide more detail about the request when no successful</li>
|
|
</ul>
|
|
<a id="md:commonjs-or-es-modules" class="tsd-anchor"></a><h3><a href="#md:commonjs-or-es-modules">CommonJS or ES Modules</a></h3><p>There is support for using either CommonJS or ES Modules depending upon your preference. This documentation will use the later in the usage examples.</p>
|
|
<a id="md:types" class="tsd-anchor"></a><h3><a href="#md:types">Types</a></h3><p>The package is written in typescript and all types are exported and available for you to use.</p>
|
|
<a id="md:full-api-documentation" class="tsd-anchor"></a><h3><a href="#md:full-api-documentation">Full API Documentation</a></h3><p>You may wish to refer to the full <a href="https://software.onspring.com/hubfs/Training/Admin%20Guide%20-%20v2%20API.pdf">Onspring API documentation</a> when determining which values to pass as parameters to some of the <code>OnspringClient</code> methods. There is also a <a href="https://api.onspring.com/swagger/index.html">swagger page</a> that you can use for making exploratory requests.</p>
|
|
<a id="md:📋-examples" class="tsd-anchor"></a><h2><a href="#md:📋-examples">📋 Examples</a></h2><p>Note the following code snippets assume you've already instantiated an <code>OnspringClient</code> as shown in the <a href="#md:onspringclient">OnspringClient</a> section.</p>
|
|
<a id="md:connectivity" class="tsd-anchor"></a><h3><a href="#md:connectivity">Connectivity</a></h3><a id="md:verify-connectivity" class="tsd-anchor"></a><h4><a href="#md:verify-connectivity">Verify connectivity</a></h4><pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">canConnect</span><span class="hl-1">();</span><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">res</span><span class="hl-1">); </span><span class="hl-8">// true or false</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:apps" class="tsd-anchor"></a><h3><a href="#md:apps">Apps</a></h3><a id="md:get-apps" class="tsd-anchor"></a><h4><a href="#md:get-apps">Get Apps</a></h4><p>Returns a paged collection of apps and/or surveys that can be paged through. By default the page size is 50 and page number is 1.</p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getApps</span><span class="hl-1">();</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">apps</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">app</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">apps</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">app</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>You can set your own page size and page number (max is 1,000) as well.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">PagingRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getApps</span><span class="hl-1">(</span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">PagingRequest</span><span class="hl-1">(</span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">));</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">apps</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">app</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">apps</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">app</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:get-app-by-id" class="tsd-anchor"></a><h4><a href="#md:get-app-by-id">Get App By Id</a></h4><p>Returns an Onspring app or survey according to provided id.</p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getAppById</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">app</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">app</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:get-apps-by-ids" class="tsd-anchor"></a><h4><a href="#md:get-apps-by-ids">Get Apps By Ids</a></h4><p>Returns a collection of Onspring apps and/or surveys according to provided ids.</p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getAppsByIds</span><span class="hl-1">([</span><span class="hl-7">130</span><span class="hl-1">, </span><span class="hl-7">131</span><span class="hl-1">]);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">apps</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">app</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">apps</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">app</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:fields" class="tsd-anchor"></a><h3><a href="#md:fields">Fields</a></h3><a id="md:get-field-by-id" class="tsd-anchor"></a><h4><a href="#md:get-field-by-id">Get Field By Id</a></h4><p>Returns an Onspring field according to provided id.</p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getFieldById</span><span class="hl-1">(</span><span class="hl-7">4793</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">field</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">field</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:get-fields-by-ids" class="tsd-anchor"></a><h4><a href="#md:get-fields-by-ids">Get Fields By Ids</a></h4><p>Returns a collection of Onspring fields according to provided ids.</p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getFieldsByIds</span><span class="hl-1">([</span><span class="hl-7">4793</span><span class="hl-1">, </span><span class="hl-7">4801</span><span class="hl-1">]);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">fields</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">field</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">fields</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">field</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:get-fields-by-app-id" class="tsd-anchor"></a><h4><a href="#md:get-fields-by-app-id">Get Fields By App Id</a></h4><p>Returns a paged collection of fields that can be paged through. By default the page size is 50 and page number is 1.</p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getFieldsByAppId</span><span class="hl-1">(</span><span class="hl-7">132</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">fields</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">field</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">fields</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">field</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>You can set your own page size and page number (max is 1,000) as well.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">PagingRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getFieldsByAppId</span><span class="hl-1">(</span><span class="hl-7">132</span><span class="hl-1">, </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">PagingRequest</span><span class="hl-1">(</span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">));</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">fields</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">field</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">fields</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">field</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:files" class="tsd-anchor"></a><h3><a href="#md:files">Files</a></h3><a id="md:get-file-info-by-id" class="tsd-anchor"></a><h4><a href="#md:get-file-info-by-id">Get File Info By Id</a></h4><p>Returns the Onspring file's metadata.</p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getFileInfoById</span><span class="hl-1">(</span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">4806</span><span class="hl-1">, </span><span class="hl-7">909</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">fileInfo</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">fileInfo</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:get-file-by-id" class="tsd-anchor"></a><h4><a href="#md:get-file-by-id">Get File By Id</a></h4><p>Returns the file itself.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-5">fs</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'fs'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getFileById</span><span class="hl-1">(</span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">4806</span><span class="hl-1">, </span><span class="hl-7">909</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">file</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">file</span><span class="hl-1">.</span><span class="hl-5">contentLength</span><span class="hl-1">);</span><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">file</span><span class="hl-1">.</span><span class="hl-5">contentType</span><span class="hl-1">);</span><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">file</span><span class="hl-1">.</span><span class="hl-5">fileName</span><span class="hl-1">);</span><br/><span class="hl-5">file</span><span class="hl-1">.</span><span class="hl-5">stream</span><span class="hl-1">.</span><span class="hl-3">pipe</span><span class="hl-1">(</span><span class="hl-5">fs</span><span class="hl-1">.</span><span class="hl-3">createWriteStream</span><span class="hl-1">(</span><span class="hl-5">file</span><span class="hl-1">.</span><span class="hl-5">fileName</span><span class="hl-1">));</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:save-file" class="tsd-anchor"></a><h4><a href="#md:save-file">Save File</a></h4><pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-5">fs</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'fs'</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">SaveFileRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">SaveFileRequest</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-7">1</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">4806</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'notes'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">Date</span><span class="hl-1">(),</span><br/><span class="hl-1"> </span><span class="hl-4">'test-attachment.txt'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'text/plain'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">fs</span><span class="hl-1">.</span><span class="hl-3">createReadStream</span><span class="hl-1">(</span><span class="hl-4">'test-attachment.txt'</span><span class="hl-1">)</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">saveFile</span><span class="hl-1">(</span><span class="hl-5">request</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">fileId</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">id</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">fileId</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:delete-file-by-id" class="tsd-anchor"></a><h4><a href="#md:delete-file-by-id">Delete File By Id</a></h4><pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">deleteFileById</span><span class="hl-1">(</span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">4806</span><span class="hl-1">, </span><span class="hl-7">1505</span><span class="hl-1">);</span><br/><br/><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">statusCode</span><span class="hl-1"> === </span><span class="hl-7">204</span><br/><span class="hl-1"> ? </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'File deleted'</span><span class="hl-1">)</span><br/><span class="hl-1"> : </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'Error deleting file'</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:lists" class="tsd-anchor"></a><h3><a href="#md:lists">Lists</a></h3><a id="md:add-or-update-list-value" class="tsd-anchor"></a><h4><a href="#md:add-or-update-list-value">Add Or Update List Value</a></h4><p>To add a list value don't provide an id value.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">ListItemRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">ListItemRequest</span><span class="hl-1">(</span><span class="hl-7">638</span><span class="hl-1">, </span><span class="hl-0">null</span><span class="hl-1">, </span><span class="hl-4">'New Value'</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-4">'#000000'</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">addOrUpdateListItem</span><span class="hl-1">(</span><span class="hl-5">request</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">itemId</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">id</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">itemId</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>To update a list value provide an id value.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">ListItemRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">ListItemRequest</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-7">638</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'35c79a46-04b8-4069-bbc1-161a175f962c'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'Updated Value'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">1</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'#000000'</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">addOrUpdateListItem</span><span class="hl-1">(</span><span class="hl-5">request</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">itemId</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">id</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">itemId</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:delete-list-value" class="tsd-anchor"></a><h4><a href="#md:delete-list-value">Delete List Value</a></h4><pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">deleteListItemById</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-7">638</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">'35c79a46-04b8-4069-bbc1-161a175f962c'</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">statusCode</span><span class="hl-1"> === </span><span class="hl-7">204</span><br/><span class="hl-1"> ? </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'List item deleted'</span><span class="hl-1">)</span><br/><span class="hl-1"> : </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'Error deleting list item'</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:records" class="tsd-anchor"></a><h3><a href="#md:records">Records</a></h3><a id="md:get-records-by-app-id" class="tsd-anchor"></a><h4><a href="#md:get-records-by-app-id">Get Records By App Id</a></h4><p>Returns a paged collection of records that can be paged through. By default the page size is 50 and page number is 1.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">GetRecordsByAppIdRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">GetRecordsByAppIdRequest</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getRecordsByAppId</span><span class="hl-1">(</span><span class="hl-5">request</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">records</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">record</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">records</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">record</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>You can set your own page size and page number (max is 1,000) as well. In addition to specifying what field values to return and in what format (Raw vs. Formatted) to return them.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">DataFormat</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">GetRecordsByAppIdRequest</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">PagingRequest</span><span class="hl-1">,</span><br/><span class="hl-1">} </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">GetRecordsByAppIdRequest</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-7">130</span><span class="hl-1">,</span><br/><span class="hl-1"> [</span><span class="hl-7">4804</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-5">DataFormat</span><span class="hl-1">.</span><span class="hl-5">Raw</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">PagingRequest</span><span class="hl-1">(</span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">)</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getRecordsByAppId</span><span class="hl-1">(</span><span class="hl-5">request</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">records</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">record</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">records</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">record</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:get-record-by-id" class="tsd-anchor"></a><h4><a href="#md:get-record-by-id">Get Record By Id</a></h4><p>Returns an onspring record based on the provided app and record ids.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">GetRecordRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">GetRecordRequest</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getRecordById</span><span class="hl-1">(</span><span class="hl-5">request</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">record</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">record</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>You can also specify what field values to return and in what format (Raw vs. Formatted) to return them.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">DataFormat</span><span class="hl-1">, </span><span class="hl-5">GetRecordRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">GetRecordRequest</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">, [</span><span class="hl-7">4804</span><span class="hl-1">], </span><span class="hl-5">DataFormat</span><span class="hl-1">.</span><span class="hl-5">Raw</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getRecordById</span><span class="hl-1">(</span><span class="hl-5">request</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">record</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">record</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:get-records-by-ids" class="tsd-anchor"></a><h4><a href="#md:get-records-by-ids">Get Records By Ids</a></h4><p>Returns a collection of Onspring records based on the provided appId and recordIds.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">GetRecordsRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">GetRecordsRequest</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">, [</span><span class="hl-7">1</span><span class="hl-1">]);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getRecordsByIds</span><span class="hl-1">(</span><span class="hl-5">request</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">records</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">record</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">records</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">record</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>You can also specify what field values to return and in what format (Raw vs. Formatted) to return them.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">DataFormat</span><span class="hl-1">, </span><span class="hl-5">GetRecordsRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">GetRecordsRequest</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">, [</span><span class="hl-7">1</span><span class="hl-1">], [</span><span class="hl-7">4804</span><span class="hl-1">], </span><span class="hl-5">DataFormat</span><span class="hl-1">.</span><span class="hl-5">Formatted</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getRecordsByIds</span><span class="hl-1">(</span><span class="hl-5">request</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">records</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">record</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">records</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">record</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:query-records" class="tsd-anchor"></a><h4><a href="#md:query-records">Query Records</a></h4><p>Returns a paged collection of records based on a criteria that can be paged through. By default the page size is 50 and page number is 1.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">FilterOperators</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">QueryFilter</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">QueryRecordsRequest</span><span class="hl-1">,</span><br/><span class="hl-1">} </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">filter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">QueryFilter</span><span class="hl-1">(</span><span class="hl-7">4745</span><span class="hl-1">, </span><span class="hl-5">FilterOperators</span><span class="hl-1">.</span><span class="hl-5">GreaterThan</span><span class="hl-1">, </span><span class="hl-7">0</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">QueryRecordsRequest</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">, </span><span class="hl-5">filter</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">queryRecords</span><span class="hl-1">(</span><span class="hl-5">request</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">records</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">record</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">records</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">record</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>You can set your own page size and page number (max is 1,000) as well. In addition to specifying what field values to return and in what format (Raw vs. Formatted) to return them.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">DataFormat</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">FilterOperators</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">PagingRequest</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">QueryFilter</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">QueryRecordsRequest</span><span class="hl-1">,</span><br/><span class="hl-1">} </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">filter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">QueryFilter</span><span class="hl-1">(</span><span class="hl-7">4745</span><span class="hl-1">, </span><span class="hl-5">FilterOperators</span><span class="hl-1">.</span><span class="hl-5">GreaterThan</span><span class="hl-1">, </span><span class="hl-7">0</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">request</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">QueryRecordsRequest</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-7">130</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">filter</span><span class="hl-1">,</span><br/><span class="hl-1"> [</span><span class="hl-7">4804</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-5">DataFormat</span><span class="hl-1">.</span><span class="hl-5">Formatted</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">PagingRequest</span><span class="hl-1">(</span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">)</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">queryRecords</span><span class="hl-1">(</span><span class="hl-5">request</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">records</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">record</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">records</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">record</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>For further details on constructing the <code>filter</code> parameter please refer to the <a href="https://software.onspring.com/hubfs/Training/Admin%20Guide%20-%20v2%20API.pdf">documentation</a> for the Onspring API.</p>
|
|
<a id="md:add-or-update-a-record" class="tsd-anchor"></a><h4><a href="#md:add-or-update-a-record">Add or Update A Record</a></h4><p>You can add a record by not providing a record id value. If successful will return the id of the added record.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">Record</span><span class="hl-1">, </span><span class="hl-5">StringRecordValue</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">record</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">Record</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">, </span><span class="hl-0">null</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">fieldValue</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">StringRecordValue</span><span class="hl-1">(</span><span class="hl-7">4804</span><span class="hl-1">, </span><span class="hl-4">'Test'</span><span class="hl-1">);</span><br/><span class="hl-5">record</span><span class="hl-1">.</span><span class="hl-3">addValue</span><span class="hl-1">(</span><span class="hl-5">fieldValue</span><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">saveRecord</span><span class="hl-1">(</span><span class="hl-5">record</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">newRecordId</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">id</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">newRecordId</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>You can update a record by providing its id. If successful will return the id of record updated.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">Record</span><span class="hl-1">, </span><span class="hl-5">StringRecordValue</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">record</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">Record</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">, </span><span class="hl-7">607</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">fieldValue</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">StringRecordValue</span><span class="hl-1">(</span><span class="hl-7">4804</span><span class="hl-1">, </span><span class="hl-4">'Updated'</span><span class="hl-1">);</span><br/><span class="hl-5">record</span><span class="hl-1">.</span><span class="hl-3">addValue</span><span class="hl-1">(</span><span class="hl-5">fieldValue</span><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">saveRecord</span><span class="hl-1">(</span><span class="hl-5">record</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">updatedRecordId</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">id</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">updatedRecordId</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:delete-record-by-id" class="tsd-anchor"></a><h4><a href="#md:delete-record-by-id">Delete Record By Id</a></h4><p>Delete an individual record based upon its id.</p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">deleteRecordById</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">, </span><span class="hl-7">607</span><span class="hl-1">);</span><br/><br/><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">statusCode</span><span class="hl-1"> === </span><span class="hl-7">204</span><br/><span class="hl-1"> ? </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'Record deleted'</span><span class="hl-1">)</span><br/><span class="hl-1"> : </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'Error deleting record'</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:delete-records-by-ids" class="tsd-anchor"></a><h4><a href="#md:delete-records-by-ids">Delete Records By Ids</a></h4><p>Delete a batch of records based upon their ids.</p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">deleteRecordsByIds</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">, [</span><span class="hl-7">608</span><span class="hl-1">, </span><span class="hl-7">609</span><span class="hl-1">]);</span><br/><br/><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">statusCode</span><span class="hl-1"> === </span><span class="hl-7">204</span><br/><span class="hl-1"> ? </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'Records deleted'</span><span class="hl-1">)</span><br/><span class="hl-1"> : </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">'Error deleting records'</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:reports" class="tsd-anchor"></a><h3><a href="#md:reports">Reports</a></h3><a id="md:get-report-by-id" class="tsd-anchor"></a><h4><a href="#md:get-report-by-id">Get Report By Id</a></h4><p>Returns the report for the provided id.</p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getReportById</span><span class="hl-1">(</span><span class="hl-7">408</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">report</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">report</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>You can also specify the format of the data in the report as well as whether you are requesting the report's data or its chart data.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">DataFormat</span><span class="hl-1">, </span><span class="hl-5">ReportDataType</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getReportById</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-7">409</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">DataFormat</span><span class="hl-1">.</span><span class="hl-5">Formatted</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">ReportDataType</span><span class="hl-1">.</span><span class="hl-5">ChartData</span><br/><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">report</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">;</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">report</span><span class="hl-1">);</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:get-reports-by-app-id" class="tsd-anchor"></a><h4><a href="#md:get-reports-by-app-id">Get Reports By App Id</a></h4><p>Returns a paged collection of reports that can be paged through. By default the page size is 50 and page number is 1.</p>
|
|
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getReportsByAppId</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">reports</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">report</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">reports</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">report</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
<p>You can set your own page size and page number (max is 1,000) as well.</p>
|
|
<pre><code class="language-js"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-5">PagingRequest</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">'onspring-api-sdk'</span><span class="hl-1">;</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1">.</span><span class="hl-3">getReportsByAppId</span><span class="hl-1">(</span><span class="hl-7">130</span><span class="hl-1">, </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">PagingRequest</span><span class="hl-1">(</span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">));</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">reports</span><span class="hl-1"> = </span><span class="hl-5">res</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">.</span><span class="hl-5">items</span><span class="hl-1">;</span><br/><br/><span class="hl-6">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">report</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-5">reports</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-5">report</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code><button>Copy</button></pre>
|
|
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:onspring-api-javascript-sdk"><span>Onspring API <wbr/>Javascript SDK</span></a><ul><li><a href="#md:🛠️-dependencies"><span>🛠️ <wbr/>Dependencies</span></a></li><li><ul><li><a href="#md:nodejs"><span>Node.js</span></a></li><li><a href="#md:axios"><span>Axios</span></a></li><li><a href="#md:form-data"><span>Form-<wbr/>Data</span></a></li></ul></li><li><a href="#md:💾-installation"><span>💾 <wbr/>Installation</span></a></li><li><a href="#md:🔑-api-key"><span>🔑 API <wbr/>Key</span></a></li><li><ul><li><a href="#md:🔒-permission-considerations"><span>🔒 <wbr/>Permission <wbr/>Considerations</span></a></li></ul></li><li><a href="#md:🧑🏻💻-start-coding"><span>🧑🏻💻 <wbr/>Start <wbr/>Coding</span></a></li><li><ul><li><a href="#md:onspringclient"><span>Onspring<wbr/>Client</span></a></li><li><a href="#md:axios-instance-configuration"><span>Axios <wbr/>Instance <wbr/>Configuration</span></a></li><li><a href="#md:apiresponse"><span>Api<wbr/>Response</span></a></li><li><a href="#md:commonjs-or-es-modules"><span>CommonJS or ES <wbr/>Modules</span></a></li><li><a href="#md:types"><span>Types</span></a></li><li><a href="#md:full-api-documentation"><span>Full API <wbr/>Documentation</span></a></li></ul></li><li><a href="#md:📋-examples"><span>📋 <wbr/>Examples</span></a></li><li><ul><li><a href="#md:connectivity"><span>Connectivity</span></a></li><li><ul><li><a href="#md:verify-connectivity"><span>Verify connectivity</span></a></li></ul></li><li><a href="#md:apps"><span>Apps</span></a></li><li><ul><li><a href="#md:get-apps"><span>Get <wbr/>Apps</span></a></li><li><a href="#md:get-app-by-id"><span>Get <wbr/>App <wbr/>By <wbr/>Id</span></a></li><li><a href="#md:get-apps-by-ids"><span>Get <wbr/>Apps <wbr/>By <wbr/>Ids</span></a></li></ul></li><li><a href="#md:fields"><span>Fields</span></a></li><li><ul><li><a href="#md:get-field-by-id"><span>Get <wbr/>Field <wbr/>By <wbr/>Id</span></a></li><li><a href="#md:get-fields-by-ids"><span>Get <wbr/>Fields <wbr/>By <wbr/>Ids</span></a></li><li><a href="#md:get-fields-by-app-id"><span>Get <wbr/>Fields <wbr/>By <wbr/>App <wbr/>Id</span></a></li></ul></li><li><a href="#md:files"><span>Files</span></a></li><li><ul><li><a href="#md:get-file-info-by-id"><span>Get <wbr/>File <wbr/>Info <wbr/>By <wbr/>Id</span></a></li><li><a href="#md:get-file-by-id"><span>Get <wbr/>File <wbr/>By <wbr/>Id</span></a></li><li><a href="#md:save-file"><span>Save <wbr/>File</span></a></li><li><a href="#md:delete-file-by-id"><span>Delete <wbr/>File <wbr/>By <wbr/>Id</span></a></li></ul></li><li><a href="#md:lists"><span>Lists</span></a></li><li><ul><li><a href="#md:add-or-update-list-value"><span>Add <wbr/>Or <wbr/>Update <wbr/>List <wbr/>Value</span></a></li><li><a href="#md:delete-list-value"><span>Delete <wbr/>List <wbr/>Value</span></a></li></ul></li><li><a href="#md:records"><span>Records</span></a></li><li><ul><li><a href="#md:get-records-by-app-id"><span>Get <wbr/>Records <wbr/>By <wbr/>App <wbr/>Id</span></a></li><li><a href="#md:get-record-by-id"><span>Get <wbr/>Record <wbr/>By <wbr/>Id</span></a></li><li><a href="#md:get-records-by-ids"><span>Get <wbr/>Records <wbr/>By <wbr/>Ids</span></a></li><li><a href="#md:query-records"><span>Query <wbr/>Records</span></a></li><li><a href="#md:add-or-update-a-record"><span>Add or <wbr/>Update <wbr/>A <wbr/>Record</span></a></li><li><a href="#md:delete-record-by-id"><span>Delete <wbr/>Record <wbr/>By <wbr/>Id</span></a></li><li><a href="#md:delete-records-by-ids"><span>Delete <wbr/>Records <wbr/>By <wbr/>Ids</span></a></li></ul></li><li><a href="#md:reports"><span>Reports</span></a></li><li><ul><li><a href="#md:get-report-by-id"><span>Get <wbr/>Report <wbr/>By <wbr/>Id</span></a></li><li><a href="#md:get-reports-by-app-id"><span>Get <wbr/>Reports <wbr/>By <wbr/>App <wbr/>Id</span></a></li></ul></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
|
|
try {
|
|
const generateLinkElement = document.querySelector(".tsd-generator a");
|
|
const link = document.createElement("a");
|
|
Object.assign(link, {
|
|
href: "https://github.com/dmnsgn/typedoc-material-theme",
|
|
target: "_blank",
|
|
rel: "noreferrer",
|
|
innerText: "typedoc-material-theme."
|
|
});
|
|
generateLinkElement.insertAdjacentElement("afterend", link);
|
|
generateLinkElement.insertAdjacentText("afterend", " with ");
|
|
} catch (error) {
|
|
|
|
}
|
|
</script></body></html> |