Create an API Console

[Anonymous]

I have been beating my head against the wall trying to figure out some things with the PLM 360 API and have been continually getting "500 - Internal Server Error" messages.  I think this is primarily due to me not formatting the body of my request correctly, but at this point, the best I can do is blindly guess at what correction needs to be made (the help guide is fairly useful, but something like that can only go so far when it's not customized for what you're trying to use it for).  Therefore, I would really love to have access to an API console similar to what 500px has set up for their API (https://apigee.com/vova/embed/console/api500px).  This would be an immense help in figuring out how the API requests should be made.

[gasevsm]

Hi Tim,

Thank you for the idea post. Presently we have PLM 360 Help > Resource Endpoints location where you should find endpoint documentation consisted of:

    - api endpoint definition,

    - its request and reponse payload schemas

    - as well as an example of each schema.

The link to bookmark and explore is here. http://help.autodesk.com/view/PLM/ENU/?guid=GUID-D70489E1-6486-4F9D-A0C6-2E2B72ACA65F.

Naturally, any product and its help content can be improved and become more self-discoverable and self-explanatory - documenting content for published API has equal needs and challenges. Having said this, I'm pleased to share that we are working towards adding AMS capability for our API and exploring portals such as one you had mentioned. This is in its infancy phase, yet is something I feel strong we should have it. May I reach out to you to undertsand your API and API documentation needs to possibly incporporate this in our plans? Meantime, please share which API you are having trouble with and we'd sure to improve our documentation as well as help you quickly get back on track.

Thanks in advance,

Martin Gasevski | PLM 360 Product Manager | Autodesk, Inc.

[Anonymous]

I'll be looking forward to using the API portal when it's released!

I ended up finding a workaround for the API request I was trying to make.  Here is what I was trying to do:

I wanted to do the following request to find the ID of a specific supplier:

POST api/rest/v1/workspaces/{id}/items/search

Ultimately, the problem I was having was that the examples in the documentation were more complicated than what I needed and I didn't know how to correctly simplify them.  I generally try my best to figure out my own solutions before running to the forums for help, but I felt like I was hunting around in the dark to get the request body formatted correctly (it doesn't help that since I'm writing my code in the SolidWorks VBA editor, I have been writing the HTTP requests in XML and the documentation is in JSON).  To say the least, the examples in the documentation seem completely sufficient (though adding duplicates in the XML format may be beneficial), but I just didn't know how to apply the information in the documentation to my specific case.  This is why having a portal will be extremely helpful.  It would be impossible to cover every use case in the documentation, and the portal would allow people to experiment with different requests without concern for the formatting of the request.

The solution I ended up coming up with was to loop through all the items returned in from the following request (which isn't really very many) until I found the supplier I was looking for:

GET api/rest/v1/workspaces/{id}/items/

[nguyentru]

Hi Tim,

This is an interesting idea.

As my colleague stated, we are still in the inphancy stage.

We will add this to our future enhancement list, and will contact you to get more ideas regarding this feature.

Thank you,

Trung

[benderk]

Thank you for submitting your idea. Have you tried the Modern Interface lately? We request that you review your idea in the context of the Modern interface. If your idea is not addressed, we invite you to create a new Idea in the context of Modern so that it can be addressed accordingly. Sincerely, Keri Bender | Global GTM Business Strategy Manager, Product Lifecycle Management