How do I enable API IDs, and where can I find them?

Diamond
Diamond
  • Updated

Issue 

Where can users find the API ID for objects in Benchling?

Environment

Notebook, Registry, Inventory, Results 

Resolution steps 

This same process applies for ALL SCHEMAS found in the registry settings.

Configure the ability to view API IDs:

Before you can view the API ID of any object in Benchling, please make sure you have the "Copy API ID" option enabled in the user settings. These can be accessed by:

  • Navigating to your avatar -> Clicking on "Settings" -> Click on the checkbox to enable the "Copy API ID" option (highlighted below) Screen Shot 2022-05-11 at 1.06.09 PM.png

 

To find the API IDs:

  • In Projects or Global Search:
    1. Find the object of choice in the Project or Global Search view
    2. Right click on the object of interest
    3. Click on "Copy API ID"
  • In entity schemas:   
    1. Go into the registry settings and select entity schemas
    2. Hover over the entity schema and on the right hand side select the </> 
    3. Copy the API IDs
  • In dropdown schemas: 
    1. Go into the registry settings and select the dropdown schemas
    2. Hover over the dropdowns and on the right hand side select the </> 
    3. Copy the API IDs
  • In inventory schemas: 
    1. Go into the registry settings and select any inventory schema
    2. Hover over the inventory schema and on the right hand side select the </> 
    3. Copy the API IDs

 

 

 

Was this article helpful?

Have more questions? Submit a request