iSheets API version 2 - iSheet admin - API - iSheet CRUD operations - Add iSheet
OVERVIEW
Method to add a new iSheet to the site. The method only allows you to define the details of an iSheet, and does not provide the capability to add columns to the iSheet. Add columns to iSheet record method should be used to add columns to the iSheet.
Request
POST /api/3/isheets/admin?siteid={siteid}
Parameters
Parameter | Value | Description |
---|---|---|
siteid |
Numeric
|
The ID of the site to create the iSheet in |
Request XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
Send iSheet Object
Response
If successful, the API returns the 200 http message with the following payload
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<isheet>
<id>{newly created isheet id}</id>
</isheet>
If the operation fails, the API will return one of the following error codes
Code | Meaning |
---|---|
201 | iSheet created successfully |
401 | Unauthorised |
403 | Validation failed/ Forbidden |
405 | Method not allowed (calling api with wrong method) |
500 | Internal error occurred |
Eoin OConnell , that doesn't sound quite right to me, I can create an iSheet with a title only:
Even if I send a request body which is missing a required parameter, we are returning a 403 code, with a decent summary of the problem in the response body.
Raise it with support (FAO Peter), including the full URI, headers and request body of the call which resulted in a 500 error and we can look into it in further detail.
Now returns 500 error if you provide only title, you need to give type as well. Might save someone else the hour of debugging.
Vandana Sharma How big is the iSheet and what are you setting your HTTP Client (RestSharp for example) time out to?
I am getting timeout error while creating isheet. how can i increase timout while creating isheet
Andrew Quinn Sorry, yes there was confusion but hopefully this has now been resolved. Please come back to me if there is anything else. Thanks.
Ryan D'Souza My apologies, there was some confusion with the parameters. This should be fixed now. Thank you for your patience. Lisa.
the above now says the parameter is `isheetid`, shouldn't it be "siteid"?
Hi Lisa Thompson, this page should read:
POST /api/3/isheets/admin?siteid={siteId}
and then in the parameters table - the same as what's in the curly brackets - siteId
Note: What's inside the curly brackets has no programmatical relevance, it could just as well be Purple Hippopotamus - as long as "Purple Hippopotamus" is referenced in the parameter table too. It just tell us where the parameter fits in the request url (/api/3/isheets...) and what that parameter pertains to.
Ryan D'Souza Hi, sorry for the delay in getting back to you. I have logged your new comments with the developer and will come back to you as soon as I can. Please note that "siteid" has been updated. Let me know if there are any further problems. Thank you.
And when it works, the http code seems to be 200, not 201.
Also the response is actually "
Thanks. Also there is another possible error code, if you forget to put the content-type header, you get 415 - unsupported media type.
Hi Ryan D'Souza - I have logged this with our developers and they are looking into this to see whats been written in the back end. I will update you as soon as we hear back. Thank you for letting us know.
site id parameter should be "siteid" not "site Id".
Comments
14 Comments