REST API Discovery Tool Examples
Become familiar with the REST API Discovery Tool (Swagger) before you begin coding so that you can build a program that interacts effectively with CAM. Practice calling operations and interpreting the responses so that you are prepared to write and troubleshoot your program.
No experience with APIs is necessary to perform the practice exercises, though some programming experience will make it easier for you to grasp the concepts. A strong background in CAM is highly recommended. Work closely with your system administrator if your CAM experience is limited.
- You must supply an access token in the Authorization header of the request. See Get an Access Token from the CAM REST API Discovery Tool and Use Tokens to Authorize Access to the CAM REST API Discovery Tool.
- Use parameters to filter the list to return specific items, return specific data for each item, and sort the list. You can also combine parameters to further refine the returned list.
- The response is returned in a paged format. Use the [page] and [pageSize] query parameters to change the default values of 1 for page and 10 for pageSize.