iSheets API
iSheets API version 2 - iSheet module - API - iSheet item - set external ID

iSheets API version 2 - iSheet module - API - iSheet item - set external ID

OVERVIEW

 

To set an external ID to an existing isheet item ID.

 

PUT /api/3/isheet/{isheetid}/items/{itemid}/externalreference/{externalid}

 

 

itemid

number

The ID of the iSheet item

externalid (Mandatory)

String (An alpha-numeric value representing the ID of the item in an external system) External system ID which is linked with an iSheet item ID. You can get the external ID from the get all iSheet item api call for example EX102

Request body

No request body required.

Response

If the operation is successful, the API returns a progressive key resource object with status of either in-progress, done, or failed otherwise an error object is returned with the appropriate error code 

OR

A validation message is displayed stating 'External ID 101 is already set to iSheet item id '3221'

Note: 

We cannot support using an external ID with a # character, as this is not supported by HTTP in the URL. Please avoid this character in the external ID. 

External IDs are case sensitive

Comments


6 Comments

Last Updated: Jun 09,2023