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
Edit: nevermind. I'm not quite sure why, but this now appears to function as expected.
Imran Aziz
The endpoint appears to only take integers and not alphabetic characters.
I'm trying to replace the external ID of an iSheet item. It is currently "10".
When I set it to "9999", it works. When I attempt "a" or "9999a" or "9999A", it fails.
I get a 403 error with the following content:
{"summary":"Invalid externalid","ref":"223"}
What are the constraints on `externalid`? Is there a character limit? Aside from octothorpe, are there other unsupported characters?
Paul Ryan I am not sure what you mean by which service, what I am suggesting is to create a custom service to do this. Thanks
Imran Aziz
Thanks but what service do I then use to fetch my record assuming I cant use get single record and use external id?
Paul Ryan if I have understood your question well, you can create a custom column and store your external id in there and use that to fetch records rather than using the system supported external ID field. Hope that helps.
Hi Does anyone know if you can set the external id to be a specific column in the UI? Can it only be set through the api? Can ou set it as part of "create" do you have to create first then set external id?
Thank you
Your review has been submitted.
Comments
6 Comments