Skip to main content
hamburger menu
+ Create a topic

Lucid for Developers

Learn from and collaborate with other developers. Find answers to your most technical questions and get support with Lucid's APIs.

  • 261 Topics
  • 947 Replies
261 Topics
R
raphael.abdias
asked in Lucid for Developers
Get List of Users - Pagination & License Information

Hi there! I’m trying to get the list of users from the API. So far i was able to get 200 users which i understand is the limit per page. With that said, i’m having a hard time trying to figure out how to move to the next page, the documentation is not clear on what should be done exactly to move to the next pageWhen i fetch the first time i get a Link Header, something like thishttps://api.lucid.co/users?pageSize=20&pageToken=eyJvIjoiMSIsImUiOjE2Mjg2OTc3OTF9>; rel="next"this is the link header of the current page, but how should i move to the next one? i mean, how to i actually use the “next” provided.Link to the documentation:https://lucid.readme.io/reference/reference-rest#paginationAlso, second question, is this Endpoint to List Users able to provide Licenses allocated to users?Thanks in advance,Rapha

913
jkrueger
B
Ben Tesch
asked in Lucid for Developers
Sharing custom shape library within company

I recently created a custom shapes library using the external API and would like to share it internally with my coworkers.  Based on https://lucid.readme.io/docs/publishing, it looks like “Private Publishing” is the way to go.There are a couple of snags:I am not an administrator on this account A marketplace listing is required, which in turn asks for URLs for a privacy policy and terms of service.  This shapes library has neither, and I don’t think I have access to hosting for this purpose.  (perhaps I could use https://example.com/ ?)Suppose I create the marketplace listing and reach out to an account administrator and they are willing to help publish this shapes library.  It looks like I would have to add them as an application owner for the library under Collaborators → Invite in the developer portal.  All they would have to do at that point is click publish, select the version, and select “publish privately”, right? Are there other ways to share custom shape libraries internally?

784
jkrueger
K
KGV
asked in Lucid for Developers
How to invoke external REST API from inside LucidChart extension plugin

I am trying to call an external REST API the way shown below, the script runs well through debug-server, but it fails with error when it is packaged and uploaded to run normally. import {EditorClient, Menu, MenuType, Viewport} from 'lucid-extension-sdk';import {prepareData} from './preparedata';import axios from 'axios';const client = new EditorClient();const menu = new Menu(client);const viewport = new Viewport(client);client.registerAction('testAction', () => { const data = new prepareData(client,viewport); data.analyzeData(); const response = axios.get('https://google.com') console.log(response)});menu.addMenuItem({ label: 'test label', action: 'testAction', menuType: MenuType.Main,});Also the code below was tried out with  import {EditorClient, Menu, MenuType, Viewport,XHRRequest} from 'lucid-extension-sdk';import {prepareData} from './preparedata';import axios from 'axios';const client = new EditorClient();const menu = new Menu(client);const viewport = ne

993
jkrueger
R
Richard Watson
asked in Lucid for Developers
No ContainedBy in JSON export?

I’m trying to use the Document Contents API endpoint to retrieve the diagram data.   I’ve noticed however that there is no “ContainedBy” data available.  This is present in the CSV export.  I have custom data fields bound to the container and would like to be able to parse the JSON in such a way to extract the both the custom data and the child elements of the container. Thank you,Richard

756
Michael B
B
Ben Tesch
asked in Lucid for Developers
Adding new custom shapes freezes document

I have a fairly complex diagram that uses a lot of shapes from a large custom shape library.I’m running into a problem where the document freezes (the zoom percentage changes but the view does not change, and I can’t pan) if I try to add a shape from this custom shape library that is not already present in the document.That is, if shape A is already in the document, I can add it no problem.  If shape B is not already in the document, adding shape B causes the document to freeze.  Sometimes the offending shape disappears right away, sometimes it doesn’t.  The shape is always gone after I reopen the document.Creating a copy of the document doesn’t fix the problem.Can you help? Please let me know how to point you to these files.  The document is a confidential work document so I cannot publicly link it.  This form doesn’t let me attach the shape library.

12314
B
Richard Udell
Richard UdellLucid support team
posted in Lucid for Developers
How to retrieve a JSON of any Lucidchart document with the Document Contents request

Are you building an application with Lucid’s external APIs that uses our Document Contents endpoint? The Document Contents endpoint uses an OAuth token with User access scope to return a JSON that describes any document accessible by the User associated with the OAuth token. Read on for more information on what to expect in the response and what to do if you return an error.Let’s take a look at a snippet from the JSON response for an example flowchart document to illustrate how the shapes on the canvas will be represented on the JSON. The magnifying glass in the screenshot below is covering a terminator shape labeled ‘Request complete’:The document content within the magnifying glass will be represented in the JSON as shown in the screenshot below:The object class (TerminatorBlock) is indicated as is the unique ItemId (q7NtnToLUGX9). Every individual shape line group and layer represented in the response will contain a unique value for ItemId to identify the object. For more details on

3978
tobi
P
PromitaDan
asked in Lucid for Developers
Issue with Data Connector in Lucid Extension - Need Help

  DescriptionI'm having trouble getting a data connector to work in my Lucid extension. Specifically, when I trigger a data connector action, I'm encountering issues that prevent the action from executing properly. I've set up the data connector in my `manifest.json` file and written the corresponding code, but it's not working as expected.Manifest.json Setup{  "dataConnectors": [    {      "name": "quodsi_data_connector",      "oauthProviderName": "",      "callbackBaseUrl": "http://localhost:5000/api",      "dataActions": {        "Simulate": "Scenario/simulate"      }    }  ]}Data Connector Index.ts import { DataConnector, DataConnectorClient } from 'lucid-extension-sdk';import { simulateAction } from './actions/simulateaction';export const makeDataConnector = (client: DataConnectorClient) =>    new DataConnector(client)        .defineAsynchronousAction("Simulate", simulateAction);SimulateAction.tsimport { DataConnectorAsynchronousAction } from 'lucid-extension-sdk';import axios

784
T
D
dbennettLucidite
posted in Lucid for Developers
Building on the Lucid Standard Import

The Use CaseAs a solutions engineer at Lucid I have the chance to work with a number of different customers and hear about so many different use cases for Lucid. One thing that has come up more and more often is importing BPMN files into Lucid as an editable diagram. Now while Lucid provides a few different document import APIs for other solutions including virtual whiteboards and Visio files Lucid hasn’t had a good solution for BPMN files. The SolutionLucid’s Standard Import allows for a JSON import to create Lucidchart diagrams in a pretty seamless way. Through the use of a conversion script we can import BPMN XML documents and create the Lucidchart documents via API.LimitationsThis conversion only supports the most commonly used BPMN shapes including the following:Parse start, intermediate throw, intermediate catch, boundary, and end events Recursively parse tasks (send, receive, user, manual, business, service, script), subProcesses, adHocSubProcesses, transactions, and callActivit

1580
D
Daniel H
Daniel H
asked in Lucid for Developers
Extension packages work in mobile app?

Hello,if you build a custom package app in Lucidchart, will that be available for users in the mobile app of Lucidchart?  Thanks, Dan

401
Humas1985
Lucid Legend Level 9
S
son.pham
asked in Lucid for Developers
Create OAuth2 App without Listing to Marketplace

Hi,We need to download all documents as images once per month, the code is running on a Virtual Machine with a schedule job that will connect to Lucid App REST API and calling some endpoints I try to create Client App in Admin Developer portal, the Test Redirect URL does not work when I enter in the browser, I got “Page not Found”. I guess I have not listed my app to the market as required, but in this case. Why do we need that step? My app does not have any logos, images, or url. What should I fill in the form? Thanks 

787
Michael B
D
darrinps
asked in Lucid for Developers
Sample code to access a directory of charts and generate .csv representations

I know that I can generate a .csv file for a given chart via the File->Export->CSV of shape data, but I’d like to do this programmatically a directory at a time.Is there any sample code of how that can be done, please?

291
Richard Udell
Vyshnavy S
Vyshnavy S
asked in Lucid for Developers
Use Lucid's Rest API to get Lucidchart shape library of documents

Iam trying to integrate Lucid chart to a third party service to provide an  option import process diagrams from Lucid Chart to our clients I have asp.net web application and I have setup Oauth 2.0 and am able to retrieve document list and contents using Lucid Rest API . But in order to convert the et lucid document to BPMN which is the set format of data import in our application I want to get the details of the shape libraries and graph < is there an API which can fetch me the details of shape library and its Names without using a legacy API which requires Oauth 1.0 authentication .

2927
Emma D
P
PromitaDan
asked in Lucid for Developers
Collaborate in open source "C# OAuth 2.0 client to the Lucid REST APIs"

Hello,For my custom LucidChart extension, I am actively working on a .NET 8.X C# OAuth 2.0 client to the Lucid REST APIs.  My approach was to create a LucidChartClientBase and then LucidChartUserClient and LucidChartAccountClient that derive from it. Here is an example of what LucidChartUserClient looks like:  static async Task UserClientStuff() { var user_client = new LucidChartUserClient(clientId, clientSecret, redirectUri, userScopes); await GetAccessTokenAsync(user_client); try { var introspectionResult = await user_client.IntrospectTokenAsync(user_client.TokenData["access_token"].ToString()); Console.WriteLine($"Introspection result: {JsonConvert.SerializeObject(introspectionResult, Formatting.Indented)}"); var accountInfo = await user_client.GetAccountInfoAsync(); Console.WriteLine($"User profile: {accountInfo}"); // Fetch all documents without any filters var allDocuments = await

553
Michael B
P
PromitaDan
asked in Lucid for Developers
Ability to add custom shapes to "Change Shape" right panel

Is there a way Load up the “Flowchart” template. Select any shape in the template.  In the right context panel, there is a label “Change Shape” where the user can pick a different shape.Is it possible to add additional shapes in this drop down box?  I would love to be able to add a few of my shapes from my custom extension package. Possible?

544
Richard Udell
B
Ben Tesch
asked in Lucid for Developers
Custom Shape Link Points

I’m trying to create a custom shape that only has two link points, similar to “DC Voltage Source 1” in the “Circuit Diagrams” → “Power Sources” library.  Link points are circled in green. When I try to create a custom shape, I can add link points just fine.  There are two below in my custom shape in the corners (because I am debugging right now), and they are circled in green.  These appear when I am drawing a line.  The trouble is, there are four points that show up by default, and I can’t figure out how to get rid of them.  They behave differently from the link points above and show up whenever I hover the cursor over my custom shape.What are these four default points, and how can I modify the custom shape definition to remove them?  The “DC Voltage Source 1” shape from Lucid’s library doesn’t have them, so it must be possible.  I just can’t figure it out from the documentation. Here’s “library.manifest” for my custom shape:{ "name": "Electrical Symbols", "shapes": [ {

1114
Connor B
P
PromitaDan
asked in Lucid for Developers
programmatic way of knowing when the shape selection has changed?

Hello,Is there a programmatic way of knowing when the shape selection has changed?I have a right context in my package and custom shapes.  My custom shapes have a  custom data property on it called q_type.  What I want to do is:Click open the right click context panel.  Keep it open. Select Shape1 which has a custom data property “q_type” value of “foo”.  Show the “foo” form in the right click panel.   User now selects Shape2 which has a custom data property “q_type” value of “bar”.  Show the “bar” form.In my extension app, can I register a method to a on selection changed event?Thanks, Dan

414
Michael B
P
PromitaDan
asked in Lucid for Developers
Document or Page custom data

I have created a LucidChart package that has custom shapes, data connectors and extension editor.  My custom package adds custom data fields to shapes and that is working great.I need similar capability to add custom data to either the document or a page.  My gut says the feature exists and is probably staring at me in the documentation but I honestly am not seeing it.  On a similar note, if the feature exists, how can I, as a standard user in LucidChart, see or manage the custom data of the document and/or page in the UI?Thanks, Dan

784
A
P
PromitaDan
asked in Lucid for Developers
Connectors in Shape Library?

I have a need to provide a Connector with custom data fields.  My intent was to add a “connector” shape to a custom shape library.  After playing with the custom shape library, I do not feel this is possible.  Is it?  assuming it is not possible, any suggestions?  Perhaps my extension package would handle whenever some creates a new connector, it detects it and adds the custom field?Thanks, Dan

625
J
Jordan B
Jordan BLucid product team
posted in Lucid for Developers
Enterprise Shield APIs

Hello, Lucid Developers Community! We're excited to announce several new APIs as part of the launch of our Enterprise Shield add-on, which brings an enhanced layer of fortified security and control to an account on Lucid’s already highly secure platform.Enterprise Shield introduces powerful APIs tailored to enhance security and compliance within your organization. Currently, Enterprise Shield offers:Document management API: Enables streamlined management of documents and folders within the Lucid ecosystem. Legal hold API: Empowers organizations to effectively manage and preserve documents during litigation. Audit logs API: Captures a diverse array of security and compliance events. To get started with Enterprise Shield APIs, check out our detailed guide in the Developer Documentation. For further inquiries or support regarding Enterprise Shield APIs, please reach out to your account team or post a question in the thread below! Cheers! Jordan, Enterprise Product Manager 

920
Jordan B
S
Steve Strassmann
asked in Lucid for Developers
Bogus intermittent "too large" error from GET /documents/{docId}/content

I've developed an app which connects to the Lucid API and calls GET https://api.lucid.co/documents/{doc_id}/contents to retrieve the contents of a document.Most of the time, my request is successful: I get back a 200 response along with the JSON document.However sometimes the Lucid API server fails to return the document. Instead I see this error.Why is this happening? The document in question is only about 360KB, so it's not particularly large, and it is certainly not being modified by anyone.Error: {"code":"badRequest",        "message":"Bad or malformed request",        "requestId":"8964e70358ce692e",        "details":{"error":"Document 62563ead-aa4a-4d29-8f2d-858a0a163b0d is too large to retrieve contents."}} ContextThe scopes used to create the access token areconst SCOPES = ["lucidchart.document.content", "offline_access", "user.profile"];The document request isconst LUCID_API_HOST = "https://api.lucid.co";const url = `${LUCID_API_HOST}/documents/${docId}/contents`;const headers

1139
A
P
PromitaDan
asked in Lucid for Developers
Iframe communication inconsistently working

Team,I am developing a LucidChart extension package.  It has editor extension, shape library, etc. Within my editor extension, I will be using Modal and Panel that gets its content from React.  I need the Lucid parent Modal or Panel to send data to child React app where the user will make some edits.  After editing, the child react form will send back to the parent Modal or Panel.I have followed the documentation but the end result is very inconsistent.  Sometimes the react app gets the message and sometimes it does not.  Maybe I have implemented it wrong.The package code, including the React app can be found in this public Repo:https://github.com/GreenShoesLLC/lucidchart_package_testHere are the details.When the user clicks on a shape, the test package adds a menu that when clicked, shows the following Lucid Modal. import { EditorClient, Modal, Viewport} from 'lucid-extension-sdk';export class EditorModal extends Modal { constructor(client: EditorClient) { super(client

683
Michael B
J
JStelly
asked in Lucid for Developers
Auditing a User's owned Documents

Hi! We like to automate our onboarding and offboarding process through a given product’s API, and part of our offboarding process for a User from Lucid is:Determining if the User owned documents Transferring those documents to another suitable UserI’m having a hard time finding an endpoint in the Lucid API docs that allows me to provide a User ID to obtain the documents they own. I don’t see a practical way of doing this. I could GET the https://api.lucid.co/documents/:id endpoint with a multi-threaded “scanner” approach that increments the documentId (a UUID) every call (this would only take several trillion API calls per User) and collects documents with a matching creatorId of the target User, but I’m hoping for a more efficient approach. I could use help. What is the simplest endpoint of the Lucid API I can use to retrieve a list of a User’s owned documents? 

695
Richard Udell
Jonathan M102
Jonathan M102
asked in Lucid for Developers
BUG: COUNTIF(source, x=> GET(x, this."Field") = this."Value") fails when "FIELD" is the output of a formula

I've created a shape object that has three fields. One field is named "Field" this is the column name of a data source where I want to count values in the rows that match a specific value. The next field is named "Value" this is the text value I want to match and count in the column of the data source. Finally I have a third field named "Count" that has a formula that counts the rows in the data source where the name matches. This solution has worked great for the last week or so. I can duplicate the shape and change the "Field" value or the "Value" value and I get the counts I want, very reusable. I wanted to evolve this by putting my shape in a container and having the "Field" value be a formula that pulled the value of the container name/label. When I did this it seemed to work the new "Dynamic Field" pulled the value I wanted that matched the static "Field" value. But when I updated the formula to use the "Dynamic Field" value my count ended up being 0.  Screen shot of the "Count"

655
Richard Udell
Michel L
Michel L
asked in Lucid for Developers
Suspicion of Bug in Rest Api Get Document content

It seems that there is a limit of document size when trying to retrieve the content of a document with the endpoint https://api.lucid.co/documents/{YourDocumentId}/contentsThe limit is about 40000 lines in the json result.If this limit is exceeded the endpoint returns an error code of 400  for bad request which is not a good response as the endpoint is successfull when the same document contains less elements (block, lines, groups, ...)Any explanation?Best regards.

403
Michael B
S
samarthakhare
asked in Lucid for Developers
Urgent Help Needed- Regarding Non-lucid Import

Hii Can I import a UML diagram created via some other tool (say PlantUml) in a lucid document through its api.If so then what will be its import format and will it be editable ??  

481
Humas1985
Lucid Legend Level 9
Lucid Software Inc. Supplemental Community Terms

Get Started

Products

Solutions

Resources

Company

Privacy Legal Cookie privacy choices Cookie policy
©   2024  Lucid Software Inc.