• Replies 2 replies
  • Subscribers 0 subscribers
  • Views 16 views
  • Users 0 members are here
Options
3sides - Social sharing widget
Related

Swagger incorrect iSheet item edit

Mike Elston
27230

In the Swagger API Docs for our site, for PUT/{version}/isheet/{isheetid}/items/{itemid}The examples given have at least one incorrect attribute name columnID should be attributecolumnid

"data":
    {
        "item":
        [
            {
                "externalID": "string",
                "itemID": "string",
                "column":
                [
                    {
                        "sequence": "string",
                        "rawData":
                        {
                            "text":
                            [
                                "string"
                           

                            "linkDisplayName": "string",
                            "linkDisplayURL": "string"
                        },
                        "title": "string",
                        "type": "string",
                        "mendatory": true,
                        "columnID": 0
                    }
                ]
            }
        ]
    },

There is also no indication which values in the body are required and which are not.
Is there a better resource for working with the rest API that does not involve hours of trial and error to sort it out.

]]>
Parents

  • Mike Elston, the older documentation contains pointers to what's needed. It's XML based, but easy enough to translate to JSON. The data models in Swagger UI are generally misleading. The JSON you provided is a mash-up of the payload for the iSheet item endpoints, and the admin payloads (iSheet columns). Unfortunately, as you've already encountered, decoding the documentation to use this API is extremely frustrating, add to this the inconsistency between endpoints (payloads), points to a lack of overarching architecture, or architect.

Reply

  • Mike Elston, the older documentation contains pointers to what's needed. It's XML based, but easy enough to translate to JSON. The data models in Swagger UI are generally misleading. The JSON you provided is a mash-up of the payload for the iSheet item endpoints, and the admin payloads (iSheet columns). Unfortunately, as you've already encountered, decoding the documentation to use this API is extremely frustrating, add to this the inconsistency between endpoints (payloads), points to a lack of overarching architecture, or architect.

Children
No Data