3DLean API documentation

Read APIs
Write APIs

How to guide

Ready to integrate 3DLean with any app on the shop floor?

Follow this comprehensive guide demonstrating how to make requests with the public APIs of 3DLean. By the end, you will know how to enable integration of 3DLean with DELMIA Solutions (e.g., Apriso, Quintiq) or with external systems.

The 3DLean API provides a wide array of functionalities to enhance team collaboration and lean management practices by allowing users to interact with Teamboards, Leangets, Sticky Notes (Action and Problem), and more. This tutorial covers a series of steps starting from the initial setup in Postman, proceeding through authentication with the 3DEXPERIENCE platform, and navigating through the process of fetching, creating, and managing data. Each step is clearly outlined to ensure you can easily authenticate, retrieve lists of teamboards, create leangets, manage action and problem sticky notes, and handle documents and attachments efficiently.

Step 1: Configuring Your Postman Environment

Before diving into the API requests, it's essential to configure your Postman environment. This setup includes specifying your 3DEXPERIENCE Platform credentials, the 3DLeanWebService endpoint, and other critical variables that will be used across different requests.

1. Import Postman Collection file into Postman. This file contains all the requests made to the 3DLean API. Please modify the following variables according to your 3DExperience Platform: teamboardTitle, trigram, filename and fileExtension.
2. Import Postman Environment file. This file contains all the necessary configurations for making requests to the 3DLean API. The file variables must be set according to the tenant that you will use such as:

• platformUsername and platformPassword for authentication.
• URLs for various services like 3DLeanWebService, 3DSpaceWebService, and 3DSwymWebService.
• tenant, basePublicModeler, and SecurityContext for accessing specific resources.

Step 2: Making API Requests

Please find some example use cases made possible by the APIs of 3DLean. More use cases are possible and also in the future, by allowing more data to be fetched, created and updated.

1. Get all Action Sticky Notes from a Teamboard
2. Get all Problem Sticky Notes from a Teamboard
3. Create a Leanget
4. Create a Action Sticky Note in the ActionLog
5. Create a Problem Sticky Note in the ProblemLog
6. Get ActionLog's and ProblemLog's tags (workaround)
7. Create a Sticky Note with a Document attached

Remember to always secure your platform credentials and adhere to best practices when interacting with APIs 

API